Skip to content
Snippets Groups Projects
Commit 8dcb099a authored by Rufai Omowunmi Balogun's avatar Rufai Omowunmi Balogun
Browse files

reformat contribution docs

parent 09477621
No related branches found
No related tags found
No related merge requests found
...@@ -23,23 +23,33 @@ Getting started ...@@ -23,23 +23,33 @@ Getting started
--------------- ---------------
1. Create an issue if one does not exist yet 1. Create an issue if one does not exist yet
a. Clearly describe the issues including the steps to reproduce it when it is a bug,
b. Ensure you fill in the earliest version that you know has the issue, * Clearly describe the issues including the steps to reproduce it when it is a bug,
* Ensure you fill in the earliest version that you know has the issue
2. Fork the repository on your GitLab account 2. Fork the repository on your GitLab account
3. Developing your changes: 3. Developing your changes:
a. Create a topic branch where you want to base your work,
b. Ensure you run the pre-commit hook before making a commit (install `pre-commit`_), * Create a topic branch where you want to base your work,
c. Run the test
* Ensure you run the pre-commit hook before making a commit (install `pre-commit`_),
* Run the test
.. code-block:: bash .. code-block:: bash
pytest tests/* pytest tests/*
4. Submitting changes 4. Submitting changes
a. Push your changes to a topic branch in your fork of the repository,
b. Submit a Pull request to the repo of the smodex package, * Push your changes to a topic branch in your fork of the repository,
c. Update the issue to show that you have submitted code and ready for Merge review,
d. Our developers will take a look at your code and give responses to your changes * Submit a Pull request to the repo of the smodex package,
* Update the issue to show that you have submitted code and ready for Merge review,
* Our developers will take a look at your code and give responses to your changes
.. _pre-commit: https://pre-commit.com/ .. _pre-commit: https://pre-commit.com/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment