Mercurial > web-octave

annotate get-involved.md @ 96:e7efa40deb17

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix URLs, Images, Titles to be up with Alex original style.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Tue, 01 Nov 2016 02:03:28 +0100
parents 25149c27c794
children 34cd51c807b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
1 ---
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
2 layout: page
96
e7efa40deb17 Fix URLs, Images, Titles to be up with Alex original style.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 95
diff changeset
3 title: Get Involved
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
4 menu: true
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
5 ---
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
6
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
7 We always need more help improving Octave and there are many ways you can
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
8 contribute. You can help by fixing bugs, developing new features, answering
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
9 questions on the mailing list or IRC channel, helping to improve the web pages.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
10
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
11 If you are wondering what to work on, we have a standard answer:
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
12 what would you like to work on? We try not to tell contributors
e8fc61e077fc Merged closed branch "kai" into default.
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
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
14 within their own field of interest. So, we would love your help,
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
15 but would also love for you to work on what you love.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
16
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
17 For some inspiration, we do maintain a [list of possible projects][1]
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
18 on the Wiki.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
19
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
20 If you have an idea on what to contribute, then join the
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
21 [`{{ site.maintainers_email }}`][2] mailing list or the IRC
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
22 [`{{ site.irc_channel }}` channel][3] in Freenode and discuss your ideas there.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
23 That way others can provide input early on, which makes your contribution more
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
24 likely to get accepted.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
25
95
25149c27c794 Removed Octicons dependeny.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 94
diff changeset
26 <div class="row ">
25149c27c794 Removed Octicons dependeny.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 94
diff changeset
27 <div class="columns small-11">
25149c27c794 Removed Octicons dependeny.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 94
diff changeset
28 <div class="panel callout">
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
29 Please do <strong>not</strong> send help requests or bug reports to the
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
30 <samp>{{ site.maintainers_email }}</samp> mailing list. Refer to the
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
31 <a href="{{ "bugs.html" | relative_url }}">bug tracker</a> or other
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
32 <a href="{{ "support.html" | relative_url }}">support options</a> instead.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
33 </div>
95
25149c27c794 Removed Octicons dependeny.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 94
diff changeset
34 </div>
25149c27c794 Removed Octicons dependeny.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 94
diff changeset
35 </div>
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
36
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
37 [1]: http://www.octave.org/wiki/Projects
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
38 [2]: https://lists.gnu.org/mailman/listinfo/octave-maintainers
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
39 [3]: http://webchat.freenode.net/?channels=octave&amp;uio=MT1mYWxzZSYyPXRydWUmMTI9dHJ1ZQda
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
40
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
41
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
42 # Using the Development Sources
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
43
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
44 The latest development sources of Octave are also available via
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
45 [Mercurial][4] (hg) archive.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
46
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
47 The primary archive address is [http://www.octave.org/hg/octave][5],
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
48 which currently redirects to [http://hg.savannah.gnu.org/hgweb/octave][6].
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
49
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
50 If you decide to use the development sources from the Mercurial archive,
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
51 please read the file [`etc/HACKING`][7] that is available with the source
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
52 files.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
53
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
54 Assuming you have Mercurial and git installed on your machine you may obtain
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
55 the latest development version of Octave sources with the following command:
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
56
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
57 {% highlight text %}
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
58 hg clone http://www.octave.org/hg/octave
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
59 {% endhighlight %}
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
60
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
61 This will clone *two* repositories, one of which is subrepository of the
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
62 main Octave repository. Once you have these, you can resync with the archive
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
63 by doing
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
64
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
65 {% highlight text %}
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
66 hg -v pull
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
67 hg -v update
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
68 {% endhighlight %}
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
69
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
70 The `-v` option is not required but provides extra information
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
71 about what was pulled and updated. The Octave manual has more
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
72 information about [contributing to Octave's development][8].
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
73
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
74 [4]: http://www.selenic.com/mercurial/wiki
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
75 [5]: http://www.octave.org/hg/octave
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
76 [6]: http://hg.savannah.gnu.org/hgweb/octave
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
77 [7]: http://www.octave.org/hg/octave/file/tip/etc/HACKING
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
78 [8]: {{ site.docs_url }}/Contributing-Guidelines.html#Contributing-Guidelines
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
79
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
80
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
81 # Octave Forge
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
82
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
83 The community-developed [Octave-Forge][9] packages expand Octave's core
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
84 functionality by providing field specific features via Octave's package system.
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
85 For example, image and signal processing, fuzzy logic, instrument control,
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
86 and statistics packages are examples of individual [Octave-Forge packages][10].
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
87
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
88 [9]: http://octave.sourceforge.net/
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
89 [10]: http://octave.sourceforge.net/packages.php