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