|
2 | 2 |
|
3 | 3 | I love to welcome your contributions. There are several ways to help out:
|
4 | 4 |
|
5 |
| -* Create an [issue](https://github.com/jonnitto/Jonnitto.ImagesInARow/issues) on GitHub, if you have found a bug |
6 |
| -* Write test cases or provide examples for open bug issues |
7 |
| -* Write patches for open bug/feature issues, preferably with test cases included |
8 |
| - |
| 5 | +- Create an [issue](https://github.com/jonnitto/Jonnitto.ImagesInARow/issues) on GitHub, if you have found a bug |
| 6 | +- Write test cases or provide examples for open bug issues |
| 7 | +- Write patches for open bug/feature issues, preferably with test cases included |
9 | 8 |
|
10 | 9 | There are a few guidelines that I need contributors to follow so that I have a
|
11 | 10 | chance of keeping on top of things.
|
12 | 11 |
|
13 |
| - |
14 | 12 | ## Getting Started
|
15 | 13 |
|
16 |
| -* Make sure you have a [GitHub account](https://github.com/signup/free). |
17 |
| -* Submit an [issue](https://github.com/jonnitto/Jonnitto.ImagesInARow/issues), assuming one does not already exist. |
18 |
| - * Clearly describe the issue including steps to reproduce when it is a bug. |
19 |
| - * Make sure you fill in the earliest version that you know has the issue. |
20 |
| -* Fork the repository on GitHub. |
| 14 | +- Make sure you have a [GitHub account](https://github.com/signup/free). |
| 15 | +- Submit an [issue](https://github.com/jonnitto/Jonnitto.ImagesInARow/issues), assuming one does not already exist. |
| 16 | + - Clearly describe the issue including steps to reproduce when it is a bug. |
| 17 | + - Make sure you fill in the earliest version that you know has the issue. |
| 18 | +- Fork the repository on GitHub. |
21 | 19 |
|
22 | 20 | ## Making Changes
|
23 | 21 |
|
24 |
| -* Create a topic branch from where you want to base your work. |
25 |
| - * This is usually the master branch. |
26 |
| - * Only target release branches if you are certain your fix must be on that |
| 22 | +- Create a topic branch from where you want to base your work. |
| 23 | + - This is usually the master branch. |
| 24 | + - Only target release branches if you are certain your fix must be on that |
27 | 25 | branch.
|
28 |
| - * To quickly create a topic branch based on master; `git branch |
29 |
| - master/my_contribution master` then checkout the new branch with `git |
30 |
| - checkout master/my_contribution`. Better avoid working directly on the |
| 26 | + - To quickly create a topic branch based on master; `git branch |
| 27 | +master/my_contribution master` then checkout the new branch with `git |
| 28 | +checkout master/my_contribution`. Better avoid working directly on the |
31 | 29 | `master` branch, to avoid conflicts if you pull in updates from origin.
|
32 |
| -* Make commits of logical units. |
33 |
| -* Check for unnecessary whitespace with `git diff --check` before committing. |
34 |
| -* Use descriptive commit messages and reference the #issue number. |
| 30 | +- Make commits of logical units. |
| 31 | +- Check for unnecessary whitespace with `git diff --check` before committing. |
| 32 | +- Use descriptive commit messages and reference the #issue number. |
35 | 33 |
|
36 | 34 | ## Submitting Changes
|
37 | 35 |
|
38 |
| -* Push your changes to a topic branch in your fork of the repository. |
39 |
| -* Submit a pull request to the repository |
| 36 | +- Push your changes to a topic branch in your fork of the repository. |
| 37 | +- Submit a pull request to the repository |
0 commit comments