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