Skip to content

Commit

Permalink
Run spellcheck to find common typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
eerimoq committed Jan 14, 2018
1 parent 54fd648 commit ad5ee3f
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ python:
- "3.6"
install:
- pip install coveralls
- pip install -r requirements.txt
script:
coverage run --source=bitstruct setup.py test
after_success:
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
test:
python2 setup.py test
python3 setup.py test
codespell -d $$(git ls-files)

release-to-pypi:
python setup.py sdist
Expand Down
24 changes: 24 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,30 @@ values:
>>> unpack('u1u3u4s16', byteswap('12', packed))
(1, 2, 3, 256)
Contributing
============

#. Install prerequisites.

.. code-block:: text
pip install -r requirements.txt
#. Fork the repository.

#. Implement the new feature or bug fix.

#. Implement test case(s) to ensure that future changes do not break
legacy.

#. Run the tests.

.. code-block:: text
make test
#. Create a pull request.

.. |buildstatus| image:: https://travis-ci.org/eerimoq/bitstruct.svg
.. _buildstatus: https://travis-ci.org/eerimoq/bitstruct

Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
codespell

0 comments on commit ad5ee3f

Please sign in to comment.