CONTRIBUTING.md

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

To set up a development environment:

• Install Poetry
• Install Make (this will be deprecated in the future)
• Then, do poetry config virtualenvs.in-project true (Only once. This will be valid for all Poetry projects on your machine.)
• Fork this repository and clone your fork
• Change to the dev branch
• Create a new branch from dev (optional)
• On the root of the repository, do poetry install --no-root
• Don't forget to activate the virtual environment (the .venv folder) on your IDE

After making your changes and writting the corresponding tests, run the following from the root of the repository:

• poetry run make test

If no errors were thrown, do a linter run to conform to cadCAD's styling guide:

• poetry run make format

Now you are good to make a PR. If you want to be absolutely sure that your code passes the best practices, run this:

• poetry run make lint

Fix the errors, if any, and then open the PR from your branch (either dev or the one you created) to the dev branch of the official repository.

Writing tests

Writing tests is simple.

• Create a file called test_something.py in the tests folder

• Write your tests as a series of functions with prototype:

  def test_this_and_that() -> None

• Then run poetry run make test