1
1
# Contributing
2
2
3
- Contributions are welcome, and they are greatly appreciated! Every little bit
4
- helps, and credit will always be given.
5
-
6
- You can contribute in many ways:
3
+ Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways:
7
4
8
5
## Types of Contributions
9
6
10
7
### Report Bugs
11
8
12
- ``` txt
13
- Report bugs at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
14
-
15
- If you are reporting a bug, please include:
16
-
17
- * Your operating system name and version.
18
- * Any details about your local setup that might be helpful in troubleshooting.
19
- * Detailed steps to reproduce the bug.
20
- ```
9
+ > ---
10
+ > Report bugs at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
11
+ >
12
+ > If you are reporting a bug, please include:
13
+ >
14
+ > * Your operating system name and version.
15
+ > * Any details about your local setup that might be helpful in troubleshooting.
16
+ > Detailed steps to reproduce the bug.
17
+ >
18
+ > ---
21
19
22
20
### Fix Bugs
23
21
24
- ``` txt
25
- Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
26
- wanted" is open to whoever wants to implement it.
22
+ > ---
23
+ > Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
24
+ > wanted" is open to whoever wants to implement it.
25
+ >
26
+ > ---
27
27
28
- Implement Features
29
- ```
28
+ ### Implement Features
30
29
31
- Look through the GitHub issues for features. Anything tagged with "enhancement"
32
- and "help wanted" is open to whoever wants to implement it.
30
+ > ---
31
+ > Look through the GitHub issues for features. Anything tagged with "enhancement"
32
+ > and "help wanted" is open to whoever wants to implement it.
33
+ >
34
+ > ---
33
35
34
36
### Write Documentation
35
37
36
- ``` txt
37
- {{ cookiecutter.project_name }} could always use more documentation, whether as part of the
38
- official {{ cookiecutter.project_name }} docs, in docstrings, or even on the web in blog posts,
39
- articles, and such.
40
- ```
38
+ > ---
39
+ > Personal Site could always use more documentation, whether as part of the
40
+ > official Personal Site docs, in docstrings, or even on the web in blog posts, articles, and such.
41
+ >
42
+ > ---
41
43
42
44
### Submit Feedback
43
45
44
- ``` txt
45
- The best way to send feedback is to file an issue at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
46
- If you are proposing a feature:
47
-
48
- * Explain in detail how it would work.
49
- * Keep the scope as narrow as possible, to make it easier to implement.
50
- * Remember that this is a volunteer-driven project, and that contributions
46
+ > ---
47
+ > The best way to send feedback is to file an issue at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
48
+ > If you are proposing a feature:
49
+ >
50
+ > * Explain in detail how it would work.
51
+ > * Keep the scope as narrow as possible, to make it easier to implement.
52
+ > * Remember that this is a volunteer-driven project, and that contributions
51
53
are welcome :)
52
- ```
54
+ > ---
53
55
54
56
### Get Started!
55
57
56
- Ready to contribute? Here's how to set up ` {{ cookiecutter.project_slug }} ` for local development.
58
+ Ready to contribute? Here's how to set up ` personal_site ` for local development.
57
59
58
- 1 . Fork the ` {{ cookiecutter.project_slug }} ` repo on GitHub.
60
+ 1 . Fork the ` personal_site ` repo on GitHub.
59
61
2 . Clone your fork locally::
60
62
61
- $ git clone
[email protected] : your_name_here /{{ cookiecutter.project_slug }}.git
63
+ ` $ git clone
[email protected] :
{{ cookiecutter.github_username }} /{{ cookiecutter.project_slug }}.git
62
64
63
65
3 . Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
64
66
65
- $ mkvirtualenv {{ cookiecutter.project_slug }}
66
- $ cd {{ cookiecutter.project_slug }}/
67
- $ python setup.py develop
68
-
69
67
4 . Create a branch for local development::
70
68
71
- $ git checkout -b name-of-your-bugfix-or-feature
72
-
73
- Now you can make your changes locally.
69
+ ` git checkout -b name-of-your-bugfix-or-feature `
74
70
75
- 5 . When you're done making changes, check that your changes pass flake8 and the
76
- tests, including testing other Python versions with tox::
71
+ Now you can make your changes locally.
77
72
78
- $ flake8 {{ cookiecutter.project_slug }} tests
79
- $ python setup.py test or pytest
80
- $ tox
81
-
82
- To get flake8 and tox, just pip install them into your virtualenv.
73
+ 5 . When you're done making changes, check that your changes pass linters and tests
83
74
84
75
6 . Commit your changes and push your branch to GitHub::
85
76
86
- $ git add .
87
- $ git commit -m "Your detailed description of your changes."
88
- $ git push origin name-of-your-bugfix-or-feature
77
+ ```
78
+ git add .
79
+ git commit -m "Your detailed description of your changes."
80
+ git push origin name-of-your-bugfix-or-feature
81
+ ```
89
82
90
83
7 . Submit a pull request through the GitHub website.
91
84
@@ -97,18 +90,20 @@ Before you submit a pull request, check that it meets these guidelines:
97
90
2 . If the pull request adds functionality, the docs should be updated. Put
98
91
your new functionality into a function with a docstring, and add the
99
92
feature to the list in README.rst.
100
- 3 . The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy . Check
101
- https://travis-ci.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }} /pull_requests
93
+ 3 . The pull request should work for Python 3.5, 3.6, 3.7 and 3.8. Check
94
+ https://travis-ci.com/eocode/personal_site /pull_requests
102
95
and make sure that the tests pass for all supported Python versions.
103
96
104
97
### Deploying
105
98
106
99
A reminder for the maintainers on how to deploy.
107
- Make sure all your changes are committed (including an entry in HISTORY.rst).
100
+ Make sure all your changes are committed (including an entry in CHANGELOG.md)
101
+
108
102
Then run::
109
103
110
- $ bump2version patch # possible: major / minor / patch
111
- $ git push
112
- $ git push --tags
104
+ Describe version patch # possible: major / minor / patch
113
105
114
- Travis will then deploy to PyPI if tests pass.
106
+ ```
107
+ git push
108
+ git push --tags
109
+ ```
0 commit comments