Mercurial > web-octave
comparison contribute.md @ 43:a1cb50997055
Reviewed and reformatted some files.
| author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
|---|---|
| date | Wed, 31 Aug 2016 01:08:06 +0200 |
| parents | a4d9175f87dc |
| children | 171ca967fcc9 7609e2a6faef |
comparison
equal
deleted
inserted
replaced
| 42:ecee119c2378 | 43:a1cb50997055 |
|---|---|
| 3 title: Contribute | 3 title: Contribute |
| 4 permalink: /contribute/ | 4 permalink: /contribute/ |
| 5 menu: true | 5 menu: true |
| 6 --- | 6 --- |
| 7 | 7 |
| 8 We always need more help improving Octave and there are many ways you can contribute. You can help by fixing bugs, developing new features, answering questions on the mailing list or IRC channel, helping to improve the web pages. | 8 We always need more help improving Octave |
| 9 and there are many ways you can contribute. | |
| 10 You can help by fixing bugs, developing new features, | |
| 11 answering questions on the mailing list or IRC channel, | |
| 12 helping to improve the web pages. | |
| 9 | 13 |
| 10 If you are wondering what to work on, we have a standard answer: what would you like to work on? We try not to tell contributors what to work on as most people do their best work when they are within their own field of interest. So, we would love your help, but would also love for you to work on what you love. | 14 If you are wondering what to work on, we have a standard answer: |
| 15 what would you like to work on? | |
| 16 We try not to tell contributors what to work on | |
| 17 as most people do their best work | |
| 18 when they are within their own field of interest. | |
| 19 So, we would love your help, | |
| 20 but would also love for you to work on what you love. | |
| 11 | 21 |
| 12 If you need some inspiration, we do maintain a list of possible projects on the [Wiki](http://www.octave.org/wiki/Projects). | 22 If you need some inspiration, |
| 23 we do maintain a list of possible projects on the | |
| 24 [Wiki](http://www.octave.org/wiki/Projects). | |
| 13 | 25 |
| 14 If you have an idea on what to contribute, then join the maintainers mailing list and discuss your ideas there. That way others can provide input early on, which makes your contribution more likely to get accepted. | 26 If you have an idea on what to contribute, |
| 27 then join the maintainers mailing list and discuss your ideas there. | |
| 28 That way others can provide input early on, | |
| 29 which makes your contribution more likely to get accepted. | |
| 15 | 30 |
| 16 ### Contacting developers | 31 ### Contacting developers |
| 17 | 32 |
| 18 If you want to participate in Octave development, you should join the [maintainers@octave.org](https://lists.gnu.org/mailman/listinfo/octave-maintainers) mailing list. Please use this list only if you are participating in Octave's development. If you are looking for help in using Octave, please use the [help@octave.org](https://lists.gnu.org/mailman/listinfo/help-octave) list instead, or check out other [support options]({{"/support-options/" | prepend: site.baseurl}}). | 33 If you want to participate in Octave development, you should join the |
| 34 [maintainers@octave.org](https://lists.gnu.org/mailman/listinfo/octave-maintainers) | |
| 35 mailing list. | |
| 36 Please use this list only if you are participating in Octave's development. | |
| 37 If you are looking for help in using Octave, please use the | |
| 38 [help@octave.org](https://lists.gnu.org/mailman/listinfo/help-octave) | |
| 39 list instead, or check out other | |
| 40 [support options]({{"/support-options/" | prepend: site.baseurl}}). | |
| 19 | 41 |
| 20 For sometimes faster communication, you can also chat in IRC in #octave in Freenode. Note, however, that the primary medium for development talk is the mailing list. | 42 For sometimes faster communication, |
| 43 you can also chat in IRC in #octave in Freenode. | |
| 44 Note, however, that the primary medium for development talk is the mailing list. | |
| 21 | 45 |
| 22 ### Using the Development Sources | 46 ### Using the Development Sources |
| 23 | 47 |
| 24 The latest development sources of Octave are also available via Mercurial (hg) archive. | 48 The latest development sources of Octave are also available via Mercurial (hg) archive. |
| 25 | 49 |
| 26 The primary archive address is [http://www.octave.org/hg/octave](http://www.octave.org/hg/octave), which currently redirects to [http://hg.savannah.gnu.org/hgweb/octave](http://hg.savannah.gnu.org/hgweb/octave). | 50 The primary archive address is |
| 51 [http://www.octave.org/hg/octave](http://www.octave.org/hg/octave), | |
| 52 which currently redirects to | |
| 53 [http://hg.savannah.gnu.org/hgweb/octave](http://hg.savannah.gnu.org/hgweb/octave). | |
| 27 | 54 |
| 28 If you decide to use the development sources from the Mercurial archive, please read the file [etc/HACKING](http://www.octave.org/hg/octave/file/tip/etc/HACKING) that is available with the source files. | 55 If you decide to use the development sources from the Mercurial archive, |
| 56 please read the file | |
| 57 [etc/HACKING](http://www.octave.org/hg/octave/file/tip/etc/HACKING) | |
| 58 that is available with the source files. | |
| 29 | 59 |
| 30 Assuming you have Mercurial and git installed on your machine you may obtain the latest development version of Octave sources with the following command: | 60 Assuming you have Mercurial and git installed on your machine you may obtain |
| 61 the latest development version of Octave sources with the following command: | |
| 31 | 62 |
| 32 hg clone http://www.octave.org/hg/octave | 63 {% highlight text %} |
| 33 | 64 hg clone http://www.octave.org/hg/octave |
| 34 This will clone two repositories, one of which is subrepository of the main Octave repository. Once you have these, you can resync with the archive by doing | 65 {% endhighlight %} |
| 35 | 66 |
| 36 hg -v pull | 67 This will clone two repositories, |
| 37 hg -v update | 68 one of which is subrepository of the main Octave repository. |
| 38 | 69 Once you have these, you can resync with the archive by doing |
| 39 The `-v` (verbose) option is not required but provides extra information about what was pulled and updated. The Octave manual has more information about contributing to Octave's development. | 70 |
| 71 {% highlight text %} | |
| 72 hg -v pull | |
| 73 hg -v update | |
| 74 {% endhighlight %} | |
| 75 | |
| 76 The `-v` (verbose) option is not required but provides extra information | |
| 77 about what was pulled and updated. | |
| 78 The Octave manual has more information about contributing to Octave's development. | |
| 40 | 79 |
| 41 ### Octave Forge | 80 ### Octave Forge |
| 42 | 81 |
| 43 The community-developed [Octave-Forge][forge] packages expand Octave's core functionality by providing field specific features via Octave's package system. For example, image and signal processing, fuzzy logic, instrument control, and statistics packages are examples of individual Octave-Forge packages. | 82 The community-developed [Octave-Forge][forge] packages expand Octave's core |
| 83 functionality by providing field specific features via Octave's package system. | |
| 84 For example, image and signal processing, fuzzy logic, instrument control, | |
| 85 and statistics packages are examples of individual Octave-Forge packages. | |
| 44 | 86 |
| 45 [forge]: http://octave.sourceforge.net/ | 87 [forge]: http://octave.sourceforge.net/ |
| 46 [forge-packages]: http://octave.sourceforge.net/packages.php | 88 [forge-packages]: http://octave.sourceforge.net/packages.php |