Mercurial > web-octave

annotate contribute.md @ 43:a1cb50997055

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