Skip to content

Commit

Permalink
docs: add a tip for with a link for commit style
Browse files Browse the repository at this point in the history
  it jsut adds a new tip for commit style in contributor page,
  which is covered in OEP-51
  • Loading branch information
ghassanmas authored and nedbat committed Mar 16, 2022
1 parent b7b5c8d commit 357c971
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions en_us/developers/source/process/contributor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ list of requirements to be sure that your pull request is ready to be reviewed:
docstrings, and good variable naming conventions are expected. See the
:doc:`../style_guides/index` for more details.

#. Commit messages should conform to `OEP-51\: Conventional Commits`_.
This style categorizes commits to make them easier to understand.

#. The pull request should be as small as possible. Each pull request should
encompass only one idea: one bugfix, one feature, etc. Multiple features (or
multiple bugfixes) should not be bundled into one pull request. A handful of
Expand Down Expand Up @@ -155,3 +158,4 @@ following links:

.. _contributor's agreement with edX: http://open.edx.org/sites/default/files/wysiwyg/individual-contributor-agreement.pdf
.. _compatible licenses: https://open.edx.org/open-edx-licensing
.. _OEP-51\: Conventional Commits: https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0051-bp-conventional-commits.html

0 comments on commit 357c971

Please sign in to comment.