Mercurial > web-octave

comparison get-involved.md @ 80:05b2f0d66aa8 kai

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some website authoring. Should be completed right now.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Fri, 14 Oct 2016 03:15:09 +0200
parents 8224b565e6fd
children 5caa2af27956
comparison
equal deleted inserted replaced
79:4e0675ad8c98 80:05b2f0d66aa8
2 layout: default 2 layout: default
3 title: Contribute 3 title: Contribute
4 menu: true 4 menu: true
5 --- 5 ---
6 6
7 We always need more help improving Octave and there are many ways 7 We always need more help improving Octave and there are many ways you can
8 you can contribute. You can help by fixing bugs, developing new 8 contribute. You can help by fixing bugs, developing new features, answering
9 features, answering questions on the mailing list or IRC channel, 9 questions on the mailing list or IRC channel, helping to improve the web pages.
10 helping to improve the web pages.
11 10
12 If you are wondering what to work on, we have a standard answer: 11 If you are wondering what to work on, we have a standard answer:
13 what would you like to work on? We try not to tell contributors 12 what would you like to work on? We try not to tell contributors
14 what to work on as most people do their best work when they are 13 what to work on as most people do their best work when they are
15 within their own field of interest. So, we would love your help, 14 within their own field of interest. So, we would love your help,
16 but would also love for you to work on what you love. 15 but would also love for you to work on what you love.
17 16
18 If you need some inspiration, we do maintain a 17 For some inspiration, we do maintain a [list of possible projects][1]
19 <a href="http://www.octave.org/wiki/Projects">list of possible projects</a>
20 on the Wiki. 18 on the Wiki.
21 19
22 If you have an idea on what to contribute, then join the 20 If you have an idea on what to contribute, then join the
23 maintainers mailing list and discuss your ideas there. That way 21 [`maintainers@octave.org`][2] mailing list or the IRC [`#octave` channel][3]
24 others can provide input early on, which makes your contribution 22 in Freenode and discuss your ideas there. That way others can provide input
25 more likely to get accepted. 23 early on, which makes your contribution more likely to get accepted.
24
25 <p>
26 <div class="alert">
27 {% octicon stop class:"octicon-stop-octave" %}
28 Please do <strong>not</strong> send help requests or bug reports to the
29 <samp>maintainers@octave.org</samp> mailing list. Refer to the
30 <a href="{{ "bugs.html" | relative_url }}">bug tracker</a> or other
31 <a href="{{ "support.html" | relative_url }}">support options</a> instead.
32 </div>
33 </p>
34
35 [1]: http://www.octave.org/wiki/Projects
36 [2]: https://lists.gnu.org/mailman/listinfo/octave-maintainers
37 [3]: http://webchat.freenode.net/?channels=octave&amp;uio=MT1mYWxzZSYyPXRydWUmMTI9dHJ1ZQda
26 38
27 39
28 ## Contacting developers 40 # Using the Development Sources
29
30 If you want to participate in Octave development, you should join
31 the <a href="https://lists.gnu.org/mailman/listinfo/octave-maintainers">
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>.
38
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.
42
43
44 ## Using the Development Sources
45 41
46 The latest development sources of Octave are also available via 42 The latest development sources of Octave are also available via
47 <a href="http://www.selenic.com/mercurial/wiki">Mercurial</a> (hg) 43 [Mercurial][4] (hg) archive.
48 archive.
49 44
50 The primary archive address 45 The primary archive address is [http://www.octave.org/hg/octave][5],
51 is <a href="http://www.octave.org/hg/octave">http://www.octave.org/hg/octave</a>, 46 which currently redirects to [http://hg.savannah.gnu.org/hgweb/octave][6].
52 which currently redirects
53 to <a href="http://hg.savannah.gnu.org/hgweb/octave">http://hg.savannah.gnu.org/hgweb/octave</a>.
54 47
55 If you decide to use the development sources from the Mercurial 48 If you decide to use the development sources from the Mercurial archive,
56 archive, please read the 49 please read the file [`etc/HACKING`][7] that is available with the source
57 file <a href="http://www.octave.org/hg/octave/file/tip/etc/HACKING"><code>etc/HACKING</code></a> 50 files.
58 that is available with the source files.
59 51
60 Assuming you have Mercurial and git installed on your machine you 52 Assuming you have Mercurial and git installed on your machine you may obtain
61 may obtain the latest development version of Octave sources with 53 the latest development version of Octave sources with the following command:
62 the following command:
63 54
64 {% highlight text %} 55 {% highlight text %}
65 hg clone http://www.octave.org/hg/octave 56 hg clone http://www.octave.org/hg/octave
66 {% endhighlight %} 57 {% endhighlight %}
67 58
68 This will clone <em>two</em> repositories, one of which is 59 This will clone *two* repositories, one of which is subrepository of the
69 subrepository of the main Octave repository. Once you have these, 60 main Octave repository. Once you have these, you can resync with the archive
70 you can resync with the archive by doing 61 by doing
71 62
72 {% highlight text %} 63 {% highlight text %}
73 hg -v pull 64 hg -v pull
74 hg -v update 65 hg -v update
75 {% endhighlight %} 66 {% endhighlight %}
76 67
77 The `-v` option is not required but provides extra information 68 The `-v` option is not required but provides extra information
78 about what was pulled and updated. The Octave manual has more 69 about what was pulled and updated. The Octave manual has more
79 information about <a href="doc/interpreter/Contributing-Guidelines.html#Contributing-Guidelines">contributing 70 information about [contributing to Octave's development][8].
80 to Octave's development</a>. 71
72 [4]: http://www.selenic.com/mercurial/wiki
73 [5]: http://www.octave.org/hg/octave
74 [6]: http://hg.savannah.gnu.org/hgweb/octave
75 [7]: http://www.octave.org/hg/octave/file/tip/etc/HACKING
76 [8]: {{ site.docs_url }}/Contributing-Guidelines.html#Contributing-Guidelines
81 77
82 78
83 ## Octave Forge 79 # Octave Forge
84 80
85 The community-developed [Octave-Forge][forge] packages expand Octave's core 81 The community-developed [Octave-Forge][9] packages expand Octave's core
86 functionality by providing field specific features via Octave's package system. 82 functionality by providing field specific features via Octave's package system.
87 For example, image and signal processing, fuzzy logic, instrument control, 83 For example, image and signal processing, fuzzy logic, instrument control,
88 and statistics packages are examples of individual Octave-Forge packages. 84 and statistics packages are examples of individual [Octave-Forge packages][10].
89 85
90 [forge]: http://octave.sourceforge.net/ 86 [9]: http://octave.sourceforge.net/
91 [forge-packages]: http://octave.sourceforge.net/packages.php 87 [10]: http://octave.sourceforge.net/packages.php