Newer
Older
.. highlight:: shell
============
Contributing
============
Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
----------------------
Report Bugs
~~~~~~~~~~~
Maeva Pourpoint
committed
Report bugs at https://git.passcal.nmt.edu/software_public/mt/lemi2seed/issues.
If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
Fix Bugs
~~~~~~~~
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.
Implement Features
~~~~~~~~~~~~~~~~~~
Look through the GitLab issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~
lemi2seed could always use more documentation, whether as part of the
official lemi2seed docs, in docstrings, or even on the web in blog posts,
articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at
Maeva Pourpoint
committed
https://git.passcal.nmt.edu/software_public/mt/lemi2seed/issues.
If you are proposing a feature:
* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)
Get Started!
------------
Ready to contribute? Here's how to set up `lemi2seed` for local development.
1. Clone the `lemi2seed` repo:
Maeva Pourpoint
committed
* $ git clone https://git.passcal.nmt.edu/software_public/mt/lemi2seed.git
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
2. Install your local copy:
* $ pip install -e .[dev]
3. Create a branch for local development:
* $ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
4. When you're done making changes, check that your changes pass the
tests:
* $ python -m unittest
5. Commit your changes and push your branch to GitHub:
* $ git add .
* $ git commit -m "Your detailed description of your changes."
* $ git push origin name-of-your-bugfix-or-feature
6. Submit a merge request through the Gitlab website.
Pull Request Guidelines
-----------------------
Before you submit a merge request, check that it meets these guidelines:
1. The merge request should include tests.
2. If the merge request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 3.[6,7,8]
Tips
----
To run a subset of tests, for the lemi2seed module for example, run:
* $ python -m unittest tests/test_lemi2seed.py
Deploying
---------
A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run:
* $ git push
* $ git push --tags