Skip to content

Commit

Permalink
README: 'Sending Pull Requests' section added (#457)
Browse files Browse the repository at this point in the history
* README: 'Sending Pull Requests' section added

Added a section to educate folks about how to sort the dictionary.txt file in preparation for a PR.

* FIX: Spaces
  • Loading branch information
luzpaz authored and larsoner committed Apr 23, 2018
1 parent dfafac2 commit b2da737
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,28 @@ directly, but instead be manually inspected. E.g.:
Note that there isn't a comma in the end of the line. The last argument is
treated as the reason why a suggestion cannot be automatically applied.

Sending Pull Requests
---------------------

If you have a suggested typo that you'd like to see merged please follow these steps:

1. Make sure you read the instructions mentioned in the ``Dictionary format`` section above to submit correctly formatted entries.

2. Sort the dictionary. This is done by invoking (in the top level directory of ``codespell/``)::

make check-dictionary

If the make script finds that you need to sort the dictionary, please then run::

make sort-dictionary

3. Only after this process is complete do we recommend you submit the PR.

**Important Notes:**

* If the dictionary is submitted without being pre-sorted the PR will fail via TravisCI.
* Not all PRs will be merged. This is pending on the discretion of the devs, maintainers, and the community.

Updating
--------

Expand Down

0 comments on commit b2da737

Please sign in to comment.