Mercurial > web-octave

annotate get-involved.md @ 84:5caa2af27956 kai

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make more use of Jekyll Makros. Website tabs reconsidering.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Mon, 17 Oct 2016 18:36:54 +0200
parents 05b2f0d66aa8
children
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
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
7 We always need more help improving Octave and there are many ways you can
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
8 contribute. You can help by fixing bugs, developing new features, answering
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
9 questions on the mailing list or IRC channel, helping to improve the web pages.
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
10
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 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
12 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
13 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
14 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
15 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
16
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
17 For some inspiration, we do maintain a [list of possible projects][1]
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
18 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
19
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 If you have an idea on what to contribute, then join the
84
5caa2af27956 Make more use of Jekyll Makros. Website tabs reconsidering.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 80
diff changeset
21 [`{{ site.maintainers_email }}`][2] mailing list or the IRC
5caa2af27956 Make more use of Jekyll Makros. Website tabs reconsidering.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 80
diff changeset
22 [`{{ site.irc_channel }}` channel][3] in Freenode and discuss your ideas there.
5caa2af27956 Make more use of Jekyll Makros. Website tabs reconsidering.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 80
diff changeset
23 That way others can provide input early on, which makes your contribution more
5caa2af27956 Make more use of Jekyll Makros. Website tabs reconsidering.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 80
diff changeset
24 likely to get accepted.
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
25
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
26 <p>
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
27 <div class="alert">
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
28 {% octicon stop class:"octicon-stop-octave" %}
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
29 Please do <strong>not</strong> send help requests or bug reports to the
84
5caa2af27956 Make more use of Jekyll Makros. Website tabs reconsidering.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 80
diff changeset
30 <samp>{{ site.maintainers_email }}</samp> mailing list. Refer to the
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
31 <a href="{{ "bugs.html" | relative_url }}">bug tracker</a> or other
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
32 <a href="{{ "support.html" | relative_url }}">support options</a> instead.
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
33 </div>
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
34 </p>
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
35
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
36 [1]: http://www.octave.org/wiki/Projects
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
37 [2]: https://lists.gnu.org/mailman/listinfo/octave-maintainers
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
38 [3]: http://webchat.freenode.net/?channels=octave&amp;uio=MT1mYWxzZSYyPXRydWUmMTI9dHJ1ZQda
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
39
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
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
41 # Using the Development Sources
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
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 The latest development sources of Octave are also available via
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
44 [Mercurial][4] (hg) archive.
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
45
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
46 The primary archive address is [http://www.octave.org/hg/octave][5],
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
47 which currently redirects to [http://hg.savannah.gnu.org/hgweb/octave][6].
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
48
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
49 If you decide to use the development sources from the Mercurial archive,
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
50 please read the file [`etc/HACKING`][7] that is available with the source
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
51 files.
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
52
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
53 Assuming you have Mercurial and git installed on your machine you may obtain
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
54 the latest development version of Octave sources with the following command:
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
55
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 {% 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
57 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
58 {% 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
59
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
60 This will clone *two* repositories, one of which is subrepository of the
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
61 main Octave repository. Once you have these, you can resync with the archive
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
62 by doing
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
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 -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
66 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
67 {% 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
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
69 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
70 about what was pulled and updated. The Octave manual has more
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
71 information about [contributing to Octave's development][8].
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
72
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
73 [4]: http://www.selenic.com/mercurial/wiki
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
74 [5]: http://www.octave.org/hg/octave
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
75 [6]: http://hg.savannah.gnu.org/hgweb/octave
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
76 [7]: http://www.octave.org/hg/octave/file/tip/etc/HACKING
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
77 [8]: {{ site.docs_url }}/Contributing-Guidelines.html#Contributing-Guidelines
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
78
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
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
80 # Octave Forge
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
81
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
82 The community-developed [Octave-Forge][9] packages expand Octave's core
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
83 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
84 For example, image and signal processing, fuzzy logic, instrument control,
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
85 and statistics packages are examples of individual [Octave-Forge packages][10].
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
86
80
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
87 [9]: http://octave.sourceforge.net/
05b2f0d66aa8 Some website authoring. Should be completed right now.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 68
diff changeset
88 [10]: http://octave.sourceforge.net/packages.php