Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.44 KB

Contributing to Neutronics Workshop

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Code of Conduct

This project and everyone participating in it is governed by the Neutronics Workshop Code of Conduct. By participating, you are expected to uphold this code.

Resources

How to Report Bugs

Neutronics Workshop is hosted on GitHub and all bugs are reported and tracked through the Issues listed on GitHub.

How to Suggest Enhancements

We welcome suggestions for new features or enhancements to the code and encourage you to submit them as Issues on GitHub.

How to Submit Changes

All changes to Neutronics Workshop happen through pull requests. We use a simplified version of the original GitFlow workflow that avoids release branches.

Code Style

We have automated PEP formatting of commits using GitHub actions so don't be surprised if your code gets reformatted when pushing to the repository.

Testing

We have a handful of tests that run on pull requests and new pull requests are expected to include tests to show that the feature works. We suggest running the tests locally before submitting a pull request.