Mercurial > web-octave

annotate get-involved.md @ 68:8224b565e6fd kai

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