Update contribution guide #636
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #636 +/- ##
=======================================
Coverage 90.54% 90.54%
=======================================
Files 56 56
Lines 2698 2698
Branches 355 355
=======================================
Hits 2443 2443
Misses 197 197
Partials 58 58Continue to review full report at Codecov.
|
bowlofeggs
reviewed
Oct 19, 2018
docs/contributing.rst
Outdated
| @@ -132,6 +132,11 @@ another ``psql`` commands:: | |||
|
|
|||
| For additional ``psql`` commands see ``man psql``. | |||
|
|
|||
| To run cron job in vagrant container run these commands:: | |||
There was a problem hiding this comment.
Suggested change
| To run cron job in vagrant container run these commands:: | |
| To run the cron job in the Vagrant guest, run these commands:: |
docs/contributing.rst
Outdated
| To run cron job in vagrant container run these commands:: | ||
|
|
||
| $ workon anitya | ||
| $ ANITYA_WEB_CONFIG=/home/vagrant/anitya.toml python files/anitya_cron.py |
There was a problem hiding this comment.
You could make it so that the workon anitya adds ANITYA_WEB_CONFIG=/home/vagrant/anitya.toml to the environment automatically.
There was a problem hiding this comment.
I added it to bashrc for vagrant guest.
docs/contributing.rst
Outdated
| @@ -209,17 +214,25 @@ If you are a maintainer and wish to make a release, follow these steps: | |||
| 1. Change the version in ``anitya.__init__.__version__``. This is used to set the | |||
| version in the documentation project and the setup.py file. | |||
|
|
|||
| 2. Generate the changelog by running ``towncrier``. | |||
| 2. Add any missing news fragment to ``news`` folder | |||
There was a problem hiding this comment.
Suggested change
| 2. Add any missing news fragment to ``news`` folder | |
| 2. Add any missing news fragments to the ``news`` folder. |
docs/contributing.rst
Outdated
| 3. Generate the changelog by running ``towncrier``. | ||
|
|
||
| .. note:: | ||
| If you added any news fragment in previous step you could see ``towncrier`` |
There was a problem hiding this comment.
Suggested change
| If you added any news fragment in previous step you could see ``towncrier`` | |
| If you added any news fragment in the previous step, you might see ``towncrier`` |
docs/contributing.rst
Outdated
|
|
||
| .. note:: | ||
| If you added any news fragment in previous step you could see ``towncrier`` | ||
| complaining about removing them, because these are not commited in git. |
There was a problem hiding this comment.
Suggested change
| complaining about removing them, because these are not commited in git. | |
| complaining about removing them, because they are not committed in git. |
docs/contributing.rst
Outdated
| .. note:: | ||
| If you added any news fragment in previous step you could see ``towncrier`` | ||
| complaining about removing them, because these are not commited in git. | ||
| Just ignore this and remove them manually, release notes will be generated |
There was a problem hiding this comment.
Suggested change
| Just ignore this and remove them manually, release notes will be generated | |
| Just ignore this and remove them manually; release notes will be generated |
|
|
||
| 4. Tag a release with ``git tag -s v<version>``. | ||
| 5. Tag a release with ``git tag -s <version>``. |
bowlofeggs
reviewed
Oct 23, 2018
|
squash |
|
The PR fixing the lint issue was merged, so I'm doing a rebase to fix also this PR. |
bowlofeggs
approved these changes
Oct 26, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When doing first release using towncrier I noticed some missing things in contribution guide.
So this PR is addressing them.