Skip to content

Commit

Permalink
rm doc/NEWS-update.jl step from CONTRIBUTING.md (#30482)
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md to stop recommending that people run `./julia doc/NEWS-update.jl` after every `NEWS.md` change in every PR.
  • Loading branch information
NHDaly authored and ararslan committed Dec 21, 2018
1 parent f503e80 commit 7c3904a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ A doctest needs to match an interactive REPL including the `julia>` prompt. To r

#### News-worthy changes

For new functionality and other substantial changes, add a brief summary to `NEWS.md`. The news item should cross reference the pull request (PR) parenthetically, in the form `([#pr])`; after adding this, run `./julia doc/NEWS-update.jl` from the `julia` directory to update the cross-reference links. To add the PR reference number, first create the PR, then push an additional commit updating `NEWS.md` with the PR reference number.
For new functionality and other substantial changes, add a brief summary to `NEWS.md`. The news item should cross reference the pull request (PR) parenthetically, in the form `([#pr])`. To add the PR reference number, first create the PR, then push an additional commit updating `NEWS.md` with the PR reference number. We periodically run `./julia doc/NEWS-update.jl` from the julia directory to update the cross-reference links, but this should not be done in a typical PR in order to avoid conflicting commits.

#### Annotations for new features, deprecations and behavior changes

Expand Down

0 comments on commit 7c3904a

Please sign in to comment.