Skip to content

Commit ad5ee3f

Browse files
committed
Run spellcheck to find common typos.
1 parent 54fd648 commit ad5ee3f

File tree

4 files changed

+27
-0
lines changed

4 files changed

+27
-0
lines changed

.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ python:
44
- "3.6"
55
install:
66
- pip install coveralls
7+
- pip install -r requirements.txt
78
script:
89
coverage run --source=bitstruct setup.py test
910
after_success:

Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
test:
22
python2 setup.py test
33
python3 setup.py test
4+
codespell -d $$(git ls-files)
45

56
release-to-pypi:
67
python setup.py sdist

README.rst

+24
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,30 @@ values:
115115
>>> unpack('u1u3u4s16', byteswap('12', packed))
116116
(1, 2, 3, 256)
117117
118+
Contributing
119+
============
120+
121+
#. Install prerequisites.
122+
123+
.. code-block:: text
124+
125+
pip install -r requirements.txt
126+
127+
#. Fork the repository.
128+
129+
#. Implement the new feature or bug fix.
130+
131+
#. Implement test case(s) to ensure that future changes do not break
132+
legacy.
133+
134+
#. Run the tests.
135+
136+
.. code-block:: text
137+
138+
make test
139+
140+
#. Create a pull request.
141+
118142
.. |buildstatus| image:: https://travis-ci.org/eerimoq/bitstruct.svg
119143
.. _buildstatus: https://travis-ci.org/eerimoq/bitstruct
120144

requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
codespell

0 commit comments

Comments
 (0)