Skip to content

Commit

Permalink
Merge pull request #575 from AMHermansen/update-CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md
  • Loading branch information
AMHermansen authored Sep 5, 2023
2 parents 8cae2ef + 5f0a6a1 commit 27fb655
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Use [GitHub issues](https://github.com/graphnet-team/graphnet/issues) for tracki

## Pull requests

Develop code in a forks of the [main repo](https://github.com/graphnet-team/graphnet). Make contributions in dedicated development/feature branches on your forked repositories, e.g. if you are implementing a specific `GraphBuiler` class you could create a branch named `add-euclidean-graph-builder` on your own fork.
Develop code in a fork of the [main repo](https://github.com/graphnet-team/graphnet). Make contributions in dedicated development/feature branches on your forked repositories, e.g. if you are implementing a specific `GraphDefinition` class you could create a branch named `add-euclidean-graph-definition` on your own fork.

Create pull requests from your development branch into `graphnet-team/graphnet:main` to contribute to the project. **To be accepted,** pull requests must:
* pass all automated checks,
Expand All @@ -20,7 +20,7 @@ Create pull requests from your development branch into `graphnet-team/graphnet:m

## Conventions

This repository aims to support python 3 version that are actively supported (currently `>=3.6`). Standard python coding conventions should be followed:
This repository aims to support python 3 version that are actively supported (currently `>=3.8`). Standard python coding conventions should be followed:

* Adhere to [PEP 8](https://www.python.org/dev/peps/pep-0008/)
* Use [pylint](https://www.pylint.org/)/[flake8](https://flake8.pycqa.org/) and [black](https://black.readthedocs.io/) to ensure as clean and well-formatted code as possible
Expand Down

0 comments on commit 27fb655

Please sign in to comment.