Skip to content

Commit

Permalink
fix: fixed Contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dmartmillan committed Jul 20, 2022
1 parent fefd8b0 commit 4c095a9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This is a brief guidelines that you need to know in order to make a contribution to the project.

1. `Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ the repository (don't try to commit on the **OpenVariant** main repository).
2. Clone your fork to your local (your computer). If you have the repo already cloned from the main github repo, just
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository (don't try to commit on the **OpenVariant** main repository).
2. Clone your fork to your local (your computer). If you have the repo already cloned from the main GitHub repository, just
add a new remote pointing at your fork, like this: ``git remote add fork <cloning address of your fork>``. Check if it
looks good: ``git remote -v``.

Expand All @@ -15,7 +15,7 @@ This is a brief guidelines that you need to know in order to make a contribution
5. Add changes: ``git add -p``
6. Commit them: ``git commit -m "feat: added a nice feature"``
8. Push it to your remote fork: ``git push origin my_new_shiny_feature``
9. Go to your fork on GitHub where your branch is. Find the option "`Pull request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_"
9. Go to your fork on GitHub where your branch is. Find the option "[Pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
which will open a pull request with the changes and make sure you are comparing your ``develop``-derived branch in your
fork to the ``develop`` branch from the ``openvariant`` repo:

Expand All @@ -25,5 +25,5 @@ If you cloned from your fork, then it should point there. You can add the main r

### Commit messages

For a good practise, it is recommended to follow `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_
For a good practise, it is recommended to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
guidance with short and self-explanatory commits.
2 changes: 1 addition & 1 deletion docs/contribution_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Contribution guide
This is a brief guidelines that you need to know in order to make a contribution to the project.

#. `Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ the repository (don't try to commit on the **OpenVariant** main repository).
#. Clone your fork to your local (your computer). If you have the repo already cloned from the main github repo, just
#. Clone your fork to your local (your computer). If you have the repo already cloned from the main GitHub repository, just
add a new remote pointing at your fork, like this: ``git remote add fork <cloning address of your fork>``. Check if it
looks good: ``git remote -v``.

Expand Down

0 comments on commit 4c095a9

Please sign in to comment.