@@ -15,7 +15,7 @@ Types of Contributions
1515Report Bugs
1616~~~~~~~~~~~
1717
18- Report bugs at https://github.com/pdssp/ {{ cookiecutter.project_slug }}/issues.
18+ Report bugs at {{ cookiecutter.project_url }}/issues.
1919
2020If you are reporting a bug, please include:
2121
@@ -26,13 +26,13 @@ If you are reporting a bug, please include:
2626Fix Bugs
2727~~~~~~~~
2828
29- Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
29+ Look through the Gitlab issues for bugs. Anything tagged with "bug" and "help
3030wanted" is open to whoever wants to implement it.
3131
3232Implement Features
3333~~~~~~~~~~~~~~~~~~
3434
35- Look through the GitHub issues for features. Anything tagged with "enhancement"
35+ Look through the Gitlab issues for features. Anything tagged with "enhancement"
3636and "help wanted" is open to whoever wants to implement it.
3737
3838Write Documentation
@@ -45,7 +45,7 @@ articles, and such.
4545Submit Feedback
4646~~~~~~~~~~~~~~~
4747
48- The best way to send feedback is to file an issue at https://github.com/pdssp/ {{ cookiecutter.project_slug }}/issues.
48+ The best way to send feedback is to file an issue at {{ cookiecutter.project_url }}/issues.
4949
5050If you are proposing a feature:
5151
@@ -59,16 +59,17 @@ Get Started!
5959
6060Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }} ` for local development.
6161
62- 1. Fork the `{{ cookiecutter.project_slug }} ` repo on GitHub .
62+ 1. Fork the `{{ cookiecutter.project_slug }} ` repo on Gitlab .
63632. Clone your fork locally::
6464
65- $ git clone git@github.com:your_name_here/ {{ cookiecutter.project_slug }}.git
65+ $ git clone {{ cookiecutter.project_url }}.git
6666
67- 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
67+ 3. Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development::
6868
69- $ mkvirtualenv {{ cookiecutter.project_slug }}
7069 $ cd {{ cookiecutter.project_slug }}/
71- $ python setup.py develop
70+ $ make prepare-dev
71+ $ source .{{ cookiecutter.project_slug }}/
72+ $ make install-dev
7273
73744. Create a branch for local development::
7475
@@ -79,19 +80,18 @@ Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }}` for
79805. When you're done making changes, check that your changes pass flake8 and the
8081 tests, including testing other Python versions with tox::
8182
82- $ flake8 {{ cookiecutter.project_slug }} tests
83- $ python setup.py test or pytest
83+ $ make lint
84+ $ make tests
8485 $ tox
8586
86- To get flake8 and tox, just pip install them into your virtualenv.
8787
88- 6. Commit your changes and push your branch to GitHub ::
88+ 6. Commit your changes and push your branch to Gitlab ::
8989
9090 $ git add .
9191 $ git commit -m "Your detailed description of your changes."
9292 $ git push origin name-of-your-bugfix-or-feature
9393
94- 7. Submit a pull request through the GitHub website.
94+ 7. Submit a pull request through the Gitlab website.
9595
9696Pull Request Guidelines
9797-----------------------
108108
109109To run a subset of tests::
110110
111- $ pytest tests.test_{{ cookiecutter.project_slug }}
111+ $ pytest tests.test_{{ cookiecutter.project_slug }}
112+
112113
113114Deploying
114115---------
@@ -117,4 +118,4 @@ A reminder for the maintainers on how to deploy.
117118Make sure all your changes are committed.
118119Then run::
119120
120- git tag -a v1.4.0 -m "my version 1.4.0"
121+ git tag -a v1.4.0 -m "my version 1.4.0"
0 commit comments