From 2911c166c49f8461f93eb9c4944381d01de58846 Mon Sep 17 00:00:00 2001 From: "Micah D. Gale" Date: Fri, 23 Feb 2024 21:01:46 -0600 Subject: [PATCH] Made draft contribution guide. --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29b..fba47e95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to MontePy + +Welcome, and thank you for considering contributing to MontePy! We look forward +to welcoming new members to the community and will do our best to help you get +up to speed. + +## Code of Conduct + +Participants in the MontePy project are expected to follow and uphold the [Code +of Conduct](CODE_OF_CONDUCT.md). Please report any unacceptable behavior to +micah.gale@inl.gov. + +## Resources + +- [GitHub Repository](https://github.com/idaholab/montepy) +- [Documentation](https://idaholab.github.io/MontePy/) +- [Developer's Guide](https://idaholab.github.io/MontePy/developing.html) + +## How to Report Bugs + +MontePy is hosted on GitHub and all bugs are reported and tracked through the +[Issues](https://github.com/idaholab/MontePy/issues) listed on GitHub. + +## How to Suggest Enhancements + +If you have suggestions for new features, feel free to suggest one as a new issue. +Keep in mind that MontePy has a small development team, +and in some cases MontePy might not be the right home for the feature. +Please review the package philosophy to see if the feature would be a good fit. + +## How to Submit Changes + +All changes to OpenMC happen through pull requests. For a full overview of the +process, see the developer's guide section on [Contributing to +OpenMC](https://docs.openmc.org/en/latest/devguide/contributing.html). + +## Code Style + +Before you run off to make changes to the code, please review the [design +philosophy](https://idaholab.github.io/MontePy/developing.html#design-philosophy), +and make sure to also use [black](https://black.readthedocs.io/en/stable/index.html).