Mercurial > web-octave
annotate contribute.md @ 25:a4d9175f87dc
rename contribution page
author | Alex Krolick <whokilledtheelectricmonk@gmail.com> |
---|---|
date | Sun, 15 Nov 2015 21:51:23 -0800 |
parents | get-involved.md@5ad190756412 |
children | a1cb50997055 |
rev | line source |
---|---|
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
1 --- |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
2 layout: page |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
3 title: Contribute |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
4 permalink: /contribute/ |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
5 menu: true |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
6 --- |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
7 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
8 We always need more help improving Octave and there are many ways you can contribute. You can help by fixing bugs, developing new features, answering questions on the mailing list or IRC channel, helping to improve the web pages. |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
9 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
10 If you are wondering what to work on, we have a standard answer: what would you like to work on? We try not to tell contributors what to work on as most people do their best work when they are within their own field of interest. So, we would love your help, but would also love for you to work on what you love. |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
11 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
12 If you need some inspiration, we do maintain a list of possible projects on the [Wiki](http://www.octave.org/wiki/Projects). |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
13 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
14 If you have an idea on what to contribute, then join the maintainers mailing list and discuss your ideas there. That way others can provide input early on, which makes your contribution more likely to get accepted. |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
15 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
16 ### Contacting developers |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
17 |
10
72e9309387f0
fix baseurl refs
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
8
diff
changeset
|
18 If you want to participate in Octave development, you should join the [maintainers@octave.org](https://lists.gnu.org/mailman/listinfo/octave-maintainers) mailing list. Please use this list only if you are participating in Octave's development. If you are looking for help in using Octave, please use the [help@octave.org](https://lists.gnu.org/mailman/listinfo/help-octave) list instead, or check out other [support options]({{"/support-options/" | prepend: site.baseurl}}). |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
19 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
20 For sometimes faster communication, you can also chat in IRC in #octave in Freenode. Note, however, that the primary medium for development talk is the mailing list. |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
21 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
22 ### Using the Development Sources |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
23 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
24 The latest development sources of Octave are also available via Mercurial (hg) archive. |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
25 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
26 The primary archive address is [http://www.octave.org/hg/octave](http://www.octave.org/hg/octave), which currently redirects to [http://hg.savannah.gnu.org/hgweb/octave](http://hg.savannah.gnu.org/hgweb/octave). |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
27 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
28 If you decide to use the development sources from the Mercurial archive, please read the file [etc/HACKING](http://www.octave.org/hg/octave/file/tip/etc/HACKING) that is available with the source files. |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
29 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
30 Assuming you have Mercurial and git installed on your machine you may obtain the latest development version of Octave sources with the following command: |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
31 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
32 hg clone http://www.octave.org/hg/octave |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
33 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
34 This will clone two repositories, one of which is subrepository of the main Octave repository. Once you have these, you can resync with the archive by doing |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
35 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
36 hg -v pull |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
37 hg -v update |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
38 |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
39 The `-v` (verbose) option is not required but provides extra information about what was pulled and updated. The Octave manual has more information about contributing to Octave's development. |
18
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
40 |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
41 ### Octave Forge |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
42 |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
43 The community-developed [Octave-Forge][forge] packages expand Octave's core functionality by providing field specific features via Octave's package system. For example, image and signal processing, fuzzy logic, instrument control, and statistics packages are examples of individual Octave-Forge packages. |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
44 |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
45 [forge]: http://octave.sourceforge.net/ |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
46 [forge-packages]: http://octave.sourceforge.net/packages.php |