From ed5dca29ddcbfa83364a78bab4c9f71843515cd3 Mon Sep 17 00:00:00 2001 From: abachmann Date: Tue, 2 Apr 2024 15:55:53 -0500 Subject: [PATCH] adjsut list formatting --- CHANGELOG.rst | 1 + CONTRIBUTING.rst | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 0512333..cdf782f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,6 +6,7 @@ Since last release: =================== **Added:** + * Added CHANGELOG.rst **Changed:** diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ce5d140..1cc1f20 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,12 +15,16 @@ information about each code. Contributions to this software are made via GitHub, so familiarity with git and the GitHub API are recommended. Resources for installing and using git and GitHub include: + * The `git website `_ + * The `GitHub docs `_ + * This `tutorial `_ on creating pull requests The general steps for contributing to OpenMCyclus are: + 1. Create a fork of the ARFC repository 2. Create a new branch on your fork, keeping the `main` branch clean and up-to-date with the ARFC repository `main` branch @@ -35,6 +39,7 @@ Reviewing pull requests ======================= Reviewing pull requests is an important part of development work. When reviewing pull requests please: + * Make sure the code is consistent with the `PEP 8 style guide `_ * Make sure all tests in CI are passing * Ensure that new tests are added as needed to address new features @@ -47,12 +52,14 @@ Running tests: ============== pytest is used for all tests. Tests should be run from the upper-most directory of this repository using: + .. code-block:: bash $ pytest tests/ Releases: ========= When a new release is ready: + #. Update all documentation as needed and issue a PR for this #. git tag -a #. git push upstream main