You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
5
+
We welcome any kind of contribution to our software, from simple comment or question to a full fledged `pull request<https://help.github.com/articles/about-pull-requests/>`_. Please read and follow our `Code of Conduct<CODE_OF_CONDUCT.rst>`_.
4
6
5
7
A contribution can be one of the following cases:
6
8
@@ -10,30 +12,33 @@ A contribution can be one of the following cases:
10
12
11
13
The sections below outline the steps in each case.
12
14
13
-
## You have a question
15
+
You have a question
16
+
*******************
14
17
15
-
1. use the search functionality [here](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues) to see if someone already filed the same issue;
18
+
1. use the search functionality `here<https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues>`_ to see if someone already filed the same issue;
16
19
1. if your issue search did not yield any relevant results, make a new issue;
17
20
1. apply the "Question" label; apply other labels when relevant.
18
21
19
-
## You think you may have found a bug
22
+
You think you may have found a bug
23
+
**********************************
20
24
21
-
1. use the search functionality [here](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues) to see if someone already filed the same issue;
25
+
1. use the search functionality `here<https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues>`_ to see if someone already filed the same issue;
22
26
1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
23
-
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
27
+
- the `SHA hashcode<https://help.github.com/articles/autolinked-references-and-urls/#commit-shas>`_ of the commit that is causing your problem;
24
28
- some identifying information (name and version number) for dependencies you're using;
25
29
- information about the operating system;
26
30
1. apply relevant labels to the newly created issue.
27
31
28
-
## You want to make some kind of change to the code base
32
+
You want to make some kind of change to the code base
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
35
+
1. (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
31
36
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
32
-
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
37
+
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions `here<https://help.github.com/articles/configuring-a-remote-for-a-fork/>`_ and `here<https://help.github.com/articles/syncing-a-fork/>`_);
33
38
1. make sure the existing tests still work by running ``python setup.py test``;
34
39
1. add your own tests (if necessary);
35
40
1. update or expand the documentation;
36
-
1.[push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the {{ cookiecutter.project_name }} repository on GitHub;
37
-
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
41
+
1. `push<http://rogerdudler.github.io/git-guide/>`_ your feature branch to (your fork of) the {{ cookiecutter.project_name }} repository on GitHub;
42
+
1. create the pull request, e.g. following the instructions `here<https://help.github.com/articles/creating-a-pull-request/>`_.
38
43
39
44
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
0 commit comments