Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
When reporting a bug please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
pythermalcomfort could always use more documentation, whether as part of the official pythermalcomfort docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
To set up pythermalcomfort for local development:
Fork pythermalcomfort (look for the “Fork” button).
Clone your fork locally:
git clone email@example.com:CenterForTheBuiltEnvironment/pythermalcomfort.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes run all the checks and docs builder with tox one command:
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
- Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rstabout the changes.
- Add yourself to
If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.
It will be slower though …
To run a subset of tests:
tox -e envname -- pytest -k test_myfeature
To run all the test environments in parallel (you need to
pip install detox):
To add a function¶
- Add the function to the python file src/pythermalcomfort/models.py and document it.
- Add any related functions that are used by your function either in src/pythermalcomfort/utilities.py or src/pythermalcomfort/psychrometrics.py. See existing code as example.
- Test your function by writing a test in tests/test_XXXX.py. Test it by running tox -e pyXX where XX is the Python version you want to use, e.g. 37
- Add autofunction to doc.reference.pythermalcomfort.py.