Skip to content

Commit

Permalink
update contributing docs with testing
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasBeuzen committed Oct 1, 2020
1 parent e19ab9a commit b115be2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
34 changes: 18 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,27 @@ Look through the (https://github.com/executablebooks/cookiecutter-jupyter-book/i
Ready to contribute? Here's how to set up `cookiecutter-jupyter-book` for local development.

1. Fork the `cookiecutter-jupyter-book` repo on GitHub.
2. Clone your fork locally:
2. Clone your fork locally and install requirements:

```
git clone git@github.com:your_name_here/cookiecutter-jupyter-book.git
```
```sh
git clone git@github.com:your_name_here/cookiecutter-jupyter-book.git
pip install -r requirements.txt
```

4. Create a branch for local development:
3. Create a branch for local development:

```
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
```sh
git checkout -b name-of-your-bugfix-or-feature
```

5. Commit your changes and push your branch to GitHub:
4. Make your desired changes, run tests, and push your branch to GitHub when you're ready:

```
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```
```sh
pytest
black ./ --check
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```

6. Open a pull request through the GitHub website. Naming convention for pull requests is [detailed here](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages). For example, a pull request that adds a new feature might be titled: `✨ NEW: validate entered github username`.
5. Open a pull request through the GitHub website. Naming convention for pull requests is [detailed here](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages). For example, a pull request that adds a new feature might be titled: `✨ NEW: validate entered github username`.
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
cookiecutter
pytest
black

0 comments on commit b115be2

Please sign in to comment.