kotovalexarian-likes-github
/
thoughtbot--shoulda-matchers
mirror of https://github.com/thoughtbot/shoulda-matchers.git
1
0
Fork 0
Code Releases Activity

Update references to changelog in other docs 

[ci skip]
This commit is contained in:
Elliot Winkler 2020-06-13 21:35:58 -06:00
parent 55c4d67c04
commit be890a94a0
2 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -190,9 +190,9 @@ updating the API, it helps us greatly to update the docs at the same time.
## A word on the changelog
You may also notice that we have a changelog in the form of [NEWS.md](NEWS.md).
You may be tempted to include changes to this in your branch, but don't worry
about this — we'll take care of it!
You may also notice that we have a changelog in the form of
[CHANGELOG.md](CHANGELOG.md). You may be tempted to include changes to this in
your branch, but don't worry about this — we'll take care of it!
## Continuous integration

19
MAINTAINING.md
View File

@ -100,9 +100,9 @@ alias zr="bundle exec zeus rspec"
## Updating the changelog
After every user-facing change makes it into master, we make a note of it in the
changelog, which for historical reasons is kept in `NEWS.md`. The changelog is
sorted in reverse order by release version, with the topmost version as the next
release (tagged as "(Unreleased)").
changelog, kept in `CHANGELOG.md`. The changelog is sorted in reverse order by
release version, with the topmost version as the next release (tagged as
"(Unreleased)").
Within each version, there are five available categories you can divide changes
into. They are all optional but they should appear in this order:
@ -126,7 +126,7 @@ such PR is available). This helps users cross-reference changes if they need to.
As mentioned in the [Contributing](CONTRIBUTING.md) document, we use YARD for
documentation. YARD is configured via `.yardopts` to process the Ruby files in
`lib/` as well as `NEWS.md` and the Markdown files in `docs/` and write the
`lib/` as well as `CHANGELOG.md` and the Markdown files in `docs/` and write the
documentation in HTML form to `doc`. This command will do exactly that:
```bash
@ -240,16 +240,13 @@ how you release a version:
and is used in the Rake tasks to publish the gem on RubyGems as well as
generate documentation.
4. Next, make sure that the current version is updated in the [Quick Links
section of the README](README.md#quick-links).
5. Assuming that everything looks good, place your changes to NEWS,
4. Assuming that everything looks good, place your changes to the changelog,
`version.rb`, and README in their own commit titled "Bump version to
*X.Y.Z*". Push this to GitHub (you can use `[ci skip]`) in the body of the
commit message to skip CI for this commit). **There is no going back after
this point!**
commit message to skip CI for this commit if you so choose). **There is no
going back after this point!**
6. Once GitHub has the version-change commit, you will run:
5. Once GitHub has the version-change commit, you will run:
```bash
rake release