diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76ab4e40..fc0adaf6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,13 +6,13 @@ First and foremost: thank you for helping with Nue! ❤️❤️ ### Guidelines -1. **Most important** If you are adding a new feature, please discuss it first under /issues. This way you'll avoid doing redundant work because not all features are automatically accepted. Nue JS strives for minimalism, which means that we have to say "no" to most things. +1. **Most important** If you are adding a new feature, please discuss it first under [GitHub issues](https://github.com/nuejs/nue/issues). This way you'll avoid doing redundant work because not all features are automatically accepted. Nue JS strives for minimalism, which means that we have to say "no" to most things. 2. Features that add lots of new code, complexity, or several new/heavy NPM packages are most likely rejected. Most definitely if the first guideline wasn't applied. 3. Please create only one thing per pull request. Easier to validate and merge. And less potential for conflicts. -3. Please add a test case for every bug fix fix +3. Please add a test case for every bug fix 3. Please write JavaScript. No TypeScript here, because Nue aims to work as close to web standards as possible. @@ -26,9 +26,9 @@ Please try to use the original style in the codebase. Do not introduce new rules 3. Indent with two spaces -4. Prefer `==` over `===`. Only strict equality only when truly needed, which is rarely +4. Prefer `==` over `===`. Strict equality only when truly needed, which is rarely the case -Nue is not using Prettier or ESLint because they will increase the project size to 40MB. The `.prettierrc.csj` file on the root directory does the job well enough. +Nue is not using Prettier or ESLint because they will increase the project size to 40MB. The `.prettierrc.yaml` file on the root directory does the job well enough.