From 588f26b060f639a0dfed86f182310e106c5905d9 Mon Sep 17 00:00:00 2001 From: Bruno Dias Date: Sun, 11 Feb 2024 21:23:28 -0300 Subject: [PATCH] contributing requirements now just need a corresponding issue... on GitHub board --- CONTRIBUTING.md | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 630b3599..e5f98273 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,10 @@ ### Commit Subjects -If your patch **changes the API or fixes a bug** please use one of the -following prefixes in your commit subject: +Patches will be only accepted if they have a corresponding issue +on GitHub. -- `[fixed] ...` -- `[changed] ...` -- `[added] ...` -- `[removed] ...` - -That ensures the subject line of your commit makes it into the -auto-generated changelog. Do not use these tags if your change doesn't -fix a bug and doesn't change the public API. - -Commits with changed, added, or removed, must be reviewed by another -collaborator. - -#### When using `[changed]` or `[removed]`... - -Please include an upgrade path with example code in the commit message. -If it doesn't make sense to do this, then it doesn't make sense to use -`[changed]` or `[removed]` :) +Having a corresponding issue is better to track +and discuss ideas and propose changes. ### Docs @@ -33,12 +18,6 @@ always be in sync. - `scripts/test` same as `npm test` but keeps karma running and watches for changes -### Build - -Please do not include the output of `scripts/build` in your commits, we -only do this when we release. (Also, you probably don't need to build -anyway unless you are fixing something around our global build.) - ## Miscellaneous if you faced the below issue, make sure you use node version < 18