Mercurial > web-octave

comparison get-involved.md @ 189:1b7537d7e54b

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