Skip to content

Commit 1b9e18d

Browse files
author
Aaron Gonzales
committed
updated docs to add contributing section
1 parent b19217f commit 1b9e18d

3 files changed

Lines changed: 54 additions & 0 deletions

File tree

README.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -804,3 +804,30 @@ Note - all Tweets are stored in UTC time.
804804
{'timePeriod': '201709220000', 'count': 0}
805805
{'timePeriod': '201709210000', 'count': 1}
806806
{'timePeriod': '201709200000', 'count': 7}
807+
808+
Contributing
809+
============
810+
811+
Any contributions should follow the following pattern:
812+
813+
1. Make a feature or bugfix branch, e.g.,
814+
``git checkout -b my_new_feature``
815+
2. Make your changes in that branch
816+
3. Ensure you bump the version number in ``searchtweets/_version.py`` to
817+
reflect your changes. We use `Semantic
818+
Versioning <https://semver.org>`__, so non-breaking enhancements
819+
should increment the minor version, e.g., ``1.5.0 -> 1.6.0``, and
820+
bugfixes will increment the last version, ``1.6.0 -> 1.6.1``.
821+
4. Create a pull request
822+
823+
After the pull request process is accepted, package maintainers will
824+
handle building documentation and distribution to Pypi.
825+
826+
For reference, distributing to Pypi is accomplished by the following
827+
commands, ran from the root directory in the repo:
828+
829+
.. code:: bash
830+
831+
python setup.py bdist_wheel
832+
python setup.py sdist
833+
twine upload dist/*

examples/base_readme.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,3 +226,12 @@ Using the Twitter Search APIs' Python Wrapper
226226
=============================================
227227

228228
.. include:: api_example.rst
229+
230+
231+
232+
233+
234+
Contributing
235+
============
236+
237+
.. include:: contributing.rst

examples/contributing.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Any contributions should follow the following pattern:
2+
3+
1. Make a feature or bugfix branch, e.g., ``git checkout -b my_new_feature``
4+
2. Make your changes in that branch
5+
3. Ensure you bump the version number in ``searchtweets/_version.py`` to reflect your changes. We use `Semantic Versioning <https://semver.org>`_, so non-breaking enhancements should increment the minor version, e.g., ``1.5.0 -> 1.6.0``, and bugfixes will increment the last version, ``1.6.0 -> 1.6.1``.
6+
4. Create a pull request
7+
8+
After the pull request process is accepted, package maintainers will handle building documentation and distribution to Pypi.
9+
10+
11+
For reference, distributing to Pypi is accomplished by the following commands, ran from the root directory in the repo:
12+
13+
.. code:: bash
14+
15+
python setup.py bdist_wheel
16+
python setup.py sdist
17+
twine upload dist/*
18+

0 commit comments

Comments
 (0)