From df6af2b2827f3e616b6acfb7da260875836113e8 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Tue, 15 Sep 2020 08:25:30 +0300 Subject: [PATCH] Add a changelog --- CHANGELOG.md | 7 +++++++ CONTRIBUTING.md | 18 ++++++++++-------- 2 files changed, 17 insertions(+), 8 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5446f2f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Change log + +## master (unreleased) + +## 1.0.0 (2020-09-15) + +Initial "stable" release after 9 years of development. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1f0014..8ba0283 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ try to follow these guidelines when you do so. ## Issue reporting -* Check that the [issue has not already been reported][5]. +* Check that the [issue has not already been reported][2]. * Check that the issue has not already been fixed in the latest code (a.k.a. `master`). * Be clear, concise and precise in your description of the problem. @@ -17,16 +17,18 @@ try to follow these guidelines when you do so. ## Pull requests -* Read [how to properly contribute to open source projects on Github][2]. +* Read [how to properly contribute to open source projects on GitHub][3]. * Use a topic branch to easily amend a pull request later, if necessary. -* Write [good commit messages][3]. +* Write [good commit messages][4]. +* Update the [changelog][5]. * Use the same coding conventions as the rest of the project. * Verify your Emacs Lisp code with `checkdoc` (C-c ? d). -* Open a [pull request][4] that relates to *only* one subject with a clear title +* Open a [pull request][6] that relates to *only* one subject with a clear title and description in grammatically correct, complete sentences. [1]: https://github.com/bbatsov/prelude/issues -[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request -[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html -[4]: https://help.github.com/articles/using-pull-requests -[5]: https://github.com/bbatsov/prelude/issues?q=is:issue +[2]: https://github.com/bbatsov/prelude/issues?q=is:issue +[3]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request +[4]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[5]: https://github.com/bbatsov/prelude/blob/master/CHANGELOG.md +[6]: https://help.github.com/articles/using-pull-requests