|
|
|
This information and more can be found in the contributing document inside each project. Remember to always work on a branch and create a merge request after pushing.
|
|
|
|
|
|
|
|
|
|
|
|
Get Started!
|
|
|
|
------------
|
|
|
|
|
|
|
|
Ready to contribute? Here's how to set up `project` for local development. (Replace `project` with the name of the passoft project you are working on)
|
|
|
|
|
|
|
|
1. Clone the `project` repo:
|
|
|
|
|
|
|
|
`$ git clone https://git.passcal.nmt.edu/passoft/project.git`
|
|
|
|
|
|
|
|
3. Install your local copy (After env setup and active!!!)
|
|
|
|
|
|
|
|
`$ pip install -e .[dev]`
|
|
|
|
|
|
|
|
4. Create a branch for local development:
|
|
|
|
|
|
|
|
`$ git checkout -b name-of-your-bugfix-or-feature`
|
|
|
|
|
|
|
|
Now you can make your changes locally.
|
|
|
|
|
|
|
|
5. When you're done making changes, check that your changes pass the
|
|
|
|
tests:
|
|
|
|
|
|
|
|
`$ python setup.py test`
|
|
|
|
|
|
|
|
6. Commit your changes and push your branch to Gitlab:
|
|
|
|
|
|
|
|
`$ git add .
|
|
|
|
$ git commit -m "Your detailed description of your changes."
|
|
|
|
$ git push origin name-of-your-bugfix-or-feature`
|
|
|
|
|
|
|
|
7. 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 merge request should work for Python 2.7
|
|
|
|
|
|
|
|
Tips
|
|
|
|
----
|
|
|
|
|
|
|
|
To run a subset of tests::
|
|
|
|
`$ python -m unittest tests.test_bline` |
|
|
\ No newline at end of file |