Skip to content

Commit bba2cc0

Browse files
committed
harmonize CONTRIBUTING.md files in template and generated
Also fix a link to a header that no longer existed in the generated project.
1 parent 25f15b1 commit bba2cc0

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ The sections below outline the steps in each case.
3434
1. make sure the existing tests still work by running ``pytest``. If project tests fail use ``pytest --keep-baked-projects`` to keep generated project files in `/tmp/pytest-*` and investigate;
3535
1. add your own tests (if necessary);
3636
1. update or expand the documentation;
37-
1. push your feature branch to (your fork of) the Python Template repository on GitHub;
37+
1. update the `CHANGELOG.md` file with your change;
38+
1. [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the Python Template repository on GitHub;
3839
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
3940

4041
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.

{{cookiecutter.directory_name}}/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ The sections below outline the steps in each case.
3030

3131
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;
3232
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/));
33+
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main 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. install dependencies (see the [development documentation](README.dev.md#development_install));
3435
1. make sure the existing tests still work by running ``pytest``;
3536
1. add your own tests (if necessary);
3637
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;
38+
1. update the `CHANGELOG.md` file with your change;
39+
1. [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the {{ cookiecutter.package_name }} repository on GitHub;
3940
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
4041

4142
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

Comments
 (0)