From 1287f293c6b86a7ae225c8170801e3420ce13fd6 Mon Sep 17 00:00:00 2001 From: PokhrelAnish <72329285+PokhrelAnish@users.noreply.github.com> Date: Sun, 4 Oct 2020 11:02:17 +0545 Subject: [PATCH 1/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f0989d2..605887c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,14 @@ # Contributing -We encourage any form of contribution, whether that be issues, comments, or pull requests. If you are going to be submitting a PR, there are a few things we would appreciate that you do to keep the codebase clean: +We encourage any form of contribution, whether that will be issues, comments, or pull requests. If you are willing to submit a PR, there are a few things we would appreciate that you do to keep the codebase clean: * **Write tests.** We try as close to 100% code coverage as possible on this repo so any new code that gets written should have accompanying tests. * **Follow the linter.** We use our [ESLint configuration with Airbnb JavaScript Styleguide](https://github.com/airbnb/javascript), and we run `npm run lint` in our Travis builds. * **Ask questions if you aren't sure.** If you have any questions while implementing a fix or feature, feel free to create an issue and ask us. We're happy to help! -## Submission Guidelines +## Submission Guidelines -### Submitting an Issue +### Submitting an Issue Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. @@ -188,7 +188,7 @@ Examples of breaking changes include: We use these three sections in changelog: new features, bug fixes, breaking changes. -List of all subjects (first lines in commit message) since last release: +List of all subjects (First lines in commit message) since last release: ```sh git log HEAD --pretty=format:%s From 9175b628caec24d07b683463a836430add88cddf Mon Sep 17 00:00:00 2001 From: PokhrelAnish <72329285+PokhrelAnish@users.noreply.github.com> Date: Sun, 4 Oct 2020 11:03:30 +0545 Subject: [PATCH 2/8] Update CONTRIBUTING.md this might help you and yours every viewer. From f5169b540e62245f73c710d7643d61553c724cfb Mon Sep 17 00:00:00 2001 From: Adrian Mejia Date: Sun, 4 Oct 2020 15:48:57 -0400 Subject: [PATCH 3/8] chore: add examples to contributing --- CONTRIBUTING.md | 36 +++++++----------------------------- notes.md | 2 +- 2 files changed, 8 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 605887c4..1a0c18a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,14 +121,17 @@ to read on GitHub as well as in various git tools. The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. + +Examples: + ``` -docs(changelog): update changelog to beta.5 -``` +feat(heap): add error handling for heaps +BREAKING CHANGE: size is now an attribute rather than a method. Similar to the built-in Map.size and Set.size ``` -fix(release): need to depend on latest rxjs and zone.js -The version in our package.json gets copied to the one we publish, and users need the latest of these. +``` +fix(book/solutions): fix missing solutions ``` ### Revert @@ -184,31 +187,6 @@ Examples of breaking changes include: * changing the side effects of using a particular API -## Generating Changelog - -We use these three sections in changelog: new features, bug fixes, breaking changes. - -List of all subjects (First lines in commit message) since last release: - -```sh -git log HEAD --pretty=format:%s - -# example -git log 1.1.0..HEAD --pretty=format:%s -``` - -New features in this release - -```sh -git log HEAD --grep feat - -# examples -git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "BREAKING CHANGE:" -git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^feat\S*:" -git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^fix\S*:" -``` - - diff --git a/notes.md b/notes.md index c868f237..1321acf3 100644 --- a/notes.md +++ b/notes.md @@ -10,7 +10,7 @@ and the meaning the the following: - Minor: Features (new functionality, adding new topics) - Patch: Fixes (bug fixes, typos, etc.) -# Generating Changelog +# Generating Changelog (manually) [deprecated] We use these three sections in changelog: new features, bug fixes, breaking changes. From 8135449234ab52c0a586b4c854c07a77d1367ec0 Mon Sep 17 00:00:00 2001 From: Adrian Mejia Date: Sun, 4 Oct 2020 15:56:48 -0400 Subject: [PATCH 4/8] chore: improves docs grammar --- CONTRIBUTING.md | 45 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a0c18a6..43e79136 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ We encourage any form of contribution, whether that will be issues, comments, or pull requests. If you are willing to submit a PR, there are a few things we would appreciate that you do to keep the codebase clean: -* **Write tests.** We try as close to 100% code coverage as possible on this repo so any new code that gets written should have accompanying tests. +* **Write tests (if applicable).** We try as close to 100% code coverage as possible on this repo, so any new code that gets written should have accompanying tests. * **Follow the linter.** We use our [ESLint configuration with Airbnb JavaScript Styleguide](https://github.com/airbnb/javascript), and we run `npm run lint` in our Travis builds. * **Ask questions if you aren't sure.** If you have any questions while implementing a fix or feature, feel free to create an issue and ask us. We're happy to help! @@ -10,15 +10,15 @@ We encourage any form of contribution, whether that will be issues, comments, or ### Submitting an Issue -Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available. ### Submitting a Pull Request (PR) -Before you submit your Pull Request (PR) consider the following guidelines: +Before you submit your Pull Request (PR), consider the following guidelines: 1. Search [GitHub](https://github.com/amejiarosario/dsa.js/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort. -1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. - Discussing the design up front helps to ensure that we're ready to accept your work. +1. Be sure that an issue describes the problem you're fixing or documents the design for the feature you'd like to add. + Discussing the design upfront helps to ensure that we're ready to accept your work. 1. Fork the `amejiarosario/dsa.js` repo. 1. Make your changes in a new git branch: @@ -29,14 +29,13 @@ Before you submit your Pull Request (PR) consider the following guidelines: 1. Create your patch, **including appropriate test cases**. 1. Run the full test suite, and ensure that all tests pass. 1. Commit your changes using a descriptive commit message that follows our - [commit message conventions](#commit). Adherence to these conventions - is necessary because release notes are automatically generated from these messages. + [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages. ```shell git commit -a ``` - Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + Note: the optional commit `-a` command-line option will automatically "add" and "rm" edited files. 1. Push your branch to GitHub: @@ -88,8 +87,8 @@ from the main (upstream) repository: ## Commit Message Guidelines -We have some guidelines how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. But also, +We have some guidelines on how our git commit messages can be formatted. These rules lead to more +readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to **generate the change log**. ### Commit Message Format @@ -104,22 +103,21 @@ format that includes a **type**, a **scope** and a **subject**: