Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.06 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or some other method before trying to make a change.

Please follow nominally's Code of Conduct in all project interactions.

Suggested Workflow

  1. Open an issue.

  2. Fork nominally to your own repository.

  3. Clone your own version and set up an environment, e.g.:

    $ git clone git@github.com:yournamehere/nominally.git
$ cd nominally
$ python -m venv .venv
$ source ./.venv/bin/activate
(.venv) $ python -m pip install -r requirements/dev.txt

  4. Create a new branch for your work.

    (.venv) $ git checkout -b informative-branch-name

  5. Pytest for tests alone...

    (.venv) $ pytest

  6. ...but nox runs all the linting required in nominally.

    (.venv) $ nox -k "test or lint"

  7. Fix things up & ensure that nox is still happy.

  8. Leave an explanatory commit message that tags the relevant issue.

  9. Push up to your own branch.

  10. Open a pull request on GitHub.