Skip to content

Commit

Permalink
Add notes on PRs and correct TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
cbueth committed Jun 12, 2024
1 parent d373e7c commit 2b083ad
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ the experience for all involved. The community looks forward to your contributio
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Your First Code Contribution](#your-first-code-contribution)
- [Improving The Documentation](#improving-the-documentation)
- [Styleguides](#styleguides)
- [Commit Messages](#commit-messages)
- [Join The Project Team](#join-the-project-team)

## I Have a Question

Expand Down Expand Up @@ -165,7 +161,37 @@ as [GitHub issues](https://github.com/NERDSITU/superblockify/issues).

<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->

<!-- omit in toc -->
### Your First Code Contribution

If you prefer to directly put your enhancement into code, you are welcome to submit a
pull request.
When doing so, we reccomend to set up your development environment with the
development dependencies and an editable installation of the package, like so:

```bash
conda create -n sb_env -c conda-forge python=3.12 -f environment-dev.yml
conda activate sb_env
pip install --no-build-isolation --no-deps -e .
```

This will install the package in editable mode, so you can make changes to the code and
see the effects immediately.
Take into consideration the same guidelines as
for [enhancement suggestions](#suggesting-enhancements) when submitting a pull request.

Additionally, make sure to include tests for your changes.
To test your changes, you can run all tests with:

```bash
pytest tests/
```

Before submitting a pull request, make sure to lint the code with `pylint` and `black`:

```bash
pylint -d E0401 superblockify/
black superblockify/ tests/
```

## Attribution

Expand Down

0 comments on commit 2b083ad

Please sign in to comment.