GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update contribute+release docs regarding changelog

Browse source
This commit is contained in:
dbr 2021-08-26 19:56:53 +10:00
parent cae03c6d7e
commit e8a4d8029b
3 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

0
.changelogs/.gitignore vendored Normal file
View file

24
CONTRIBUTING.md
View file

@ -7,6 +7,10 @@ It also means that things are changing quickly, and lots of stuff is planned tha
If you would like to work on TaskChampion, please contact the developers (via the issue tracker) before spending a lot of time working on a pull request.
Doing so may save you some wasted time and frustration!
A good starting point might be one of the issues tagged with ["good first issue"][first].
[first]: https://github.com/taskchampion/taskchampion/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
# Other Ways To Help
The best way to help this project to grow is to help spread awareness of it.
@ -15,7 +19,6 @@ Tell your friends, post to social media, blog about it -- whatever works best!
Other ideas;
* Improve the documentation where it's unclear or lacking some information
* Build and maintain tools that integrate with TaskChampion
* Devise a nice TaskChampion logo
# Development Guide
@ -44,8 +47,19 @@ You may be able to limit the scope of what you need to understand to just one cr
You can generate the documentation for the `taskchampion` crate with `cargo doc --release --open -p taskchampion`.
## Making a Pull Request
## Making a Pull Request
We expect contributors to follow the [GitHub Flow](https://guides.github.com/introduction/flow/).
Aside from that, we have no particular requirements on pull requests.
Make your patch, double-check that it's complete (tests? docs? documentation comments?), and make a new pull request.
We expect contributors to follow the [GitHub Flow](https://guides.github.com/introduction/flow/).
Aside from that, we have no particular requirements on pull requests.
Make your patch, double-check that it's complete (tests? docs? documentation comments?), and make a new pull request.
Any non-trivial change (particularly those that change the behaviour of the application, or change the API) should be noted in the projects changelog.
In order to manage this, changelog entries are stored as text files in the `.changelog/` directory at the repository root.
To add a new changelog entry, you can simply run `python3 ./script/changelog.py add "Fixed thingo to increase zorbloxification [Issue #2](http://example.com)`
This creates a file named `./changelogs/yyyy-mm-dd-branchname.txt` (timestamp, current git branch) which contains a markdown snippet.
If you don't have a Python 3 intepreter installed, you can simply create this file manually. It should contain a list item like `- Fixed thingo [...]`
Periodically (probably just before release), these changelog entries are concatenated combined together and added into the `CHANGELOG.md` file.

1
RELEASING.md
View file

@ -1,5 +1,6 @@
# Release process
1. Ensure the changelog is updated with everything from the `.changelogs` directory. `python3 ./script/changelog.py build` will output a Markdown snippet to include in `CHANGELOG.md` then `rm .changelog/*.txt`
1. Run `git pull upstream main`
1. Run `cargo test`
1. Run `cargo clean && cargo clippy`