Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

85 lines (57 loc) · 2.55 KB

Contributing

We are accepting contributions at this time. Please read the contribution guidelines carefully.

Contribution Guidelines

When developing for nurse.py, consider the following:

  1. Non-technical users will need to execute it.
    1. Our Users shouldn't need to know or work with Git to use nurse.py.
    2. Python knowledge shouldn't be a requirement for using it.
    3. The only command they should know is how to run nurse.py with a checklist.json they have received.
  2. It needs to run on most OS distributions, and most Python versions. The more it supports, the larger the audience that will be able to use it.
  3. When deployed, there should be a very minimal footprint.
    1. Users should feel comfortable downloading and running this on production servers.

These are the key to maintaining this utility's value for its users.

Table of Contents

Prerequisites

You should install the following tools before starting to develop

  1. Install Python 3.8.+
  2. Install pipenv for python dependency management
  • zsh shell:
pip install pipenv
echo export PIPENV_VENV_IN_PROJECT=true >> ~/.zshrc
  • bash shell:
pip install pipenv
echo export PIPENV_VENV_IN_PROJECT=true >> ~/.bashrc

Development

  1. Install dependencies for development (there should be none for nurse.py)
pipenv install --dev
  1. Enter virtual env by:
pipenv shell

Testing

  1. Run unit tests by:
pytest --html=report.html
  1. View unit test results by navigating in your browser to the report.html file.

Contributing

  1. Fork the project
  2. Clone your fork
  3. Make local changes to your fork by editing files
  4. Commit your changes
  5. Push your local changes to the remote server
  6. Create new Pull Request

From here your pull request will be reviewed and once you've responded to all feedback it will be merged into the project. Congratulations, you're a contributor!