Skip to content

Commit

Permalink
adjsut list formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
abachma2 committed Apr 2, 2024
1 parent 5d079ff commit ed5dca2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Since last release:
===================

**Added:**

* Added CHANGELOG.rst

**Changed:**
Expand Down
7 changes: 7 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://git-scm.com/>`_

* The `GitHub docs <https://docs.github.com/en>`_

* This `tutorial <https://help.github.com/articles/using-pull-requests/>`_ 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
Expand All @@ -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 <https://peps.python.org/pep-0008/>`_
* Make sure all tests in CI are passing
* Ensure that new tests are added as needed to address new features
Expand All @@ -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 <version>
#. git push upstream main
Expand Down

0 comments on commit ed5dca2

Please sign in to comment.