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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ The sections below outline the steps in each case.
34
34
1. make sure the existing tests still work by running ``pytest``. If project tests fails use ``pytest --keep-baked-projects`` to keep generated project in /tmp/pytest-* and investigate;
35
35
1. add your own tests (if necessary);
36
36
1. update or expand the documentation;
37
-
1.[push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the Python Template repository on GitHub;
37
+
1. push your feature branch to (your fork of) the Python Template repository on GitHub;
38
38
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
39
39
40
40
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.
- Miscellaneous files, such as [Change log]({{cookiecutter.project_name}}/CHANGELOG.rst), [Code of Conduct]({{cookiecutter.project_name}}/CODE_OF_CONDUCT.rst), and [Contributing guidelines]({{cookiecutter.project_name}}/CONTRIBUTING.rst),
17
-
- A [README]({{cookiecutter.project_name}}/README.rst) and [a separate document]({{cookiecutter.project_name}}/project_setup.md) with extensive documentation about project setup.
16
+
- Miscellaneous files, such as [Change log]({{cookiecutter.project_name}}/CHANGELOG.md), [Code of Conduct]({{cookiecutter.project_name}}/CODE_OF_CONDUCT.md), and [Contributing guidelines]({{cookiecutter.project_name}}/CONTRIBUTING.md),
17
+
- A [README]({{cookiecutter.project_name}}/README.md) and [a separate document]({{cookiecutter.project_name}}/project_setup.md) with extensive documentation about project setup.
18
18
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/)
19
19
20
20
## Badges
@@ -76,10 +76,10 @@ Good job! You have now generated the skeleton for your package:
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).
4
+
5
+
A contribution can be one of the following cases:
6
+
7
+
1. you have a question;
8
+
1. you think you may have found a bug (including unexpected behavior);
9
+
1. you want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation);
10
+
1. you want to make a new release of the code base.
11
+
12
+
The sections below outline the steps in each case.
13
+
14
+
## You have a question
15
+
16
+
1. use the search functionality [here]({{cookiecutter.repository}}/issues) to see if someone already filed the same issue;
17
+
2. if your issue search did not yield any relevant results, make a new issue;
18
+
3. apply the "Question" label; apply other labels when relevant.
19
+
20
+
## You think you may have found a bug
21
+
22
+
1. use the search functionality [here]({{cookiecutter.repository}}/issues) to see if someone already filed the same issue;
23
+
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:
24
+
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
25
+
- some identifying information (name and version number) for dependencies you're using;
26
+
- information about the operating system;
27
+
1. apply relevant labels to the newly created issue.
28
+
29
+
## You want to make some kind of change to the code base
30
+
31
+
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;
32
+
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
33
+
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/));
34
+
1. make sure the existing tests still work by running ``pytest``;
35
+
1. add your own tests (if necessary);
36
+
1. update or expand the documentation;
37
+
1. update the `CHANGELOG.md` file with change;
38
+
1. push your feature branch to (your fork of) the {{ cookiecutter.package_name }} repository on GitHub;
39
+
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
40
+
41
+
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