1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="stylesheet" type="text/css" href="html.css" />
<title>Contributing to JAS</title>
</head>
<body class="main">
<h1>Contributing to JAS</h1>
<p>
Follow these guidelines if you'd like to contribute to the JAS project.
</p>
<p>
If you have any questions about using or developing for this project, send me
an email <a href="#mt">[1]</a>.
</p>
<h3>Issues and Bugs</h3>
<p>
Submit an issue <a href="#ni">[2]</a> or pull request <a href="#np">[3]</a> with a
fix if you find any bugs in the project. See below (<a href="#spr">submitting pull requests</a>)
for instructions on sending in pull requests.
</p>
<p>
When submitting an issue or pull request, make sure you're as detailed as possible
and fill in all answers to questions asked in the templates. For example, an issue
that simply states "xyz isn't working!" will be ignored.
</p>
<h3>Feature Requests</h3>
<p>
Submit an issue <a href="#ni">[2]</a> to request a new feature. Features fall into one of two
categories:
</p>
<ul>
<li>
<strong>Major:</strong> Major changes should be discussed with me via email <a href="#mt">[1]</a>. I'm
always open to suggestions and will get back to you as soon as I can!
</li>
<li>
<strong>Minor:</strong> A minor feature can simply be added via a pull request <a href="#np">[3]</a>.
</li>
</ul>
<h3><a name="spr">Submitting Pull Requests</a></h3>
<p>
Before you do anything, make sure you check the current list of pull requests <a href="#pr">[4]</a>
to ensure you aren't duplicating anyone's work. Then, do the following:
</p>
<ol>
<li>
Fork the repository and make your changes in a git branch:
`<code>git checkout -b my-branch master</code>`
</li>
<li>
Make sure your feature or fix doesn't break the project! Test thoroughly.
</li>
<li>
Commit your changes, and be sure to leave a detailed commit message.
</li>
<li>
Push your branch to your forked repo on any Git server:
`<code>git push origin my-branch</code>`
</li>
<li>
Submit a pull request <a href="#np">[3]</a> and hold tight!
</li>
<li>
If any changes are requested by the project maintainers, make them and follow
this process again until the changes are merged.
</li>
</ol>
<ol>
<li>
<a name="mt" href="mailto:kredel at rz.uni-mannheim.de">mail to me</a>
</li>
<li>
<a name="ni" href="https://github.com/kredel/java-algebra-system/issues/new" target="con">new issue</a>
</li>
<li>
<a name="np" href="https://github.com/kredel/java-algebra-system/compare" target="con">new pull request</a>
</li>
<li>
<a name="pr" href="https://github.com/kredel/java-algebra-system/pulls" target="con">pull requests</a>
</li>
</ol>
<hr />
<address><a href="mailto:kredel at rz.uni-mannheim.de">Heinz Kredel</a></address>
<p>
<!-- Created: Sat Aug 4 12:22:04 CEST 2018 -->
<!-- hhmts start -->
Last modified: Sat Aug 4 12:59:45 CEST 2018
<!-- hhmts end -->
</p>
<!--p align="right" >
$Id$
</p-->
</body>
</html>
|
