Skip to content

Commit

Permalink
newsfragments: Move the newsfragments to the root of the project
Browse files Browse the repository at this point in the history
Navigating to newsfragments directory and creating a file there is
necessary for each new feature or bugfix. Being hidden in the directory
tree wastes some seconds for everyone who needs to look there. To avoid
this let's move the directory to the root of the project.
  • Loading branch information
p12tic committed Sep 19, 2021
1 parent 82c0d44 commit 4c82a21
Show file tree
Hide file tree
Showing 15 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -13,5 +13,5 @@ http://docs.buildbot.net/latest/developer/pull-request.html
## Contributor Checklist:

* [ ] I have updated the unit tests
* [ ] I have created a file in the `master/buildbot/newsfragments` directory (and read the `README.txt` in that directory)
* [ ] I have created a file in the `newsfragments` directory (and read the `README.txt` in that directory)
* [ ] I have updated the appropriate documentation
2 changes: 1 addition & 1 deletion RELEASING.rst
Expand Up @@ -35,7 +35,7 @@ This will have much faster turnaround compared to if the error is noticed after
If any errors are found, just amend the commit created by `make release_notes`.

Certain file names are not properly supported by the `towncrier` tool and it ignores them.
Check `master/buildbot/newsfragments` directory for any forgotten release notes
Check `newsfragments` directory for any forgotten release notes

Step 3: Merge the release notes PR
----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion master/docs/developer/pull-request.rst
Expand Up @@ -29,7 +29,7 @@ Guidelines
If you have trouble with tests that fail without any of your changes applied, get in touch with the developers for help.

* Pull requests that add features or change existing behavior should include a brief description in the release notes.
See the master/buildbot/newsfragments directory and read the `README.txt <https://github.com/buildbot/buildbot/blob/master/master/buildbot/newsfragments/README.txt>`_ file therein.
See the `newsfragments` directory and read the `README.txt <https://github.com/buildbot/buildbot/blob/master/newsfragments/README.txt>`_ file therein.

* Git commit messages form the "ChangeLog" for Buildbot, and as such should be as descriptive as possible.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions pyproject.toml
@@ -1,6 +1,7 @@
[tool.towncrier]
package = "buildbot"
package_dir = "master"
directory = "newsfragments"
filename = "master/docs/relnotes/index.rst"
template = "master/docs/relnotes.rst.jinja"
title_format = "{name} ``{version}`` ( ``{project_date}`` )"
Expand Down

0 comments on commit 4c82a21

Please sign in to comment.