added all files to project

This commit is contained in:
2022-03-10 10:36:59 +01:00
parent 09dd957b33
commit 46a936d7de
25351 changed files with 3883356 additions and 0 deletions
+94
View File
@@ -0,0 +1,94 @@
# Managing issues
We manage issues consistently for the benefit of ourselves and our users.
## Labels
Use [labels](https://github.com/stylelint/stylelint/labels).
When you first triage an issue, you should:
- add one of the `status: needs *` labels, e.g. `status: need discussion`
- don't add any other label
After triage, you should add:
- _one_ of the non-need `status: *` labels, e.g. `status: ready to implement`
- _zero or one_ of the `type: *` labels, e.g. `status: new rule`
- _zero, one or more_ of the `syntax: *` labels, e.g. `syntax: scss`
- optionally, the `good first issue`, `help wanted`, `priority: high` and `upstream` labels
## Milestones
Use [milestones](https://github.com/stylelint/stylelint/milestones).
You should:
- use the `future-major` milestone for issues that introduce breaking changes
- optionally, create version milestones (e.g. `8.x`) to manage upcoming releases
## Titles
Rename the title into a consistent format.
You should:
- lead with the [CHANGELOG group names](pull-requests.md), but in the present tense:
- "Remove y", e.g. "Remove unit-disallowed-list"
- "Deprecate x in y", e.g. "Deprecate resolvedNested option in selector-class-pattern"
- "Add y", e.g. "Add unit-disallowed-list"
- "Add x to y", e.g. "Add ignoreProperties: [] to property-disallowed-list"
- "Fix false positives/negatives for x in y", e.g. "Fix false positives for Less mixins in color-no-hex"
- use `*` if the issue applies to a group of rules, e.g. "Fix false negatives for SCSS variables in selector-\*-pattern"
## Saved replies
You should use [saved replies](https://help.github.com/en/github/writing-on-github/working-with-saved-replies).
### Close an issue
That doesn't use a template:
```md
Thank you for creating this issue. However, issues need to follow one of our templates so that we can clearly understand your particular circumstances.
Please help us help you by [recreating the issue](https://github.com/stylelint/stylelint/issues/new/choose) using one of our templates.
```
That is best-suited as a plugin:
```md
Thank you for your suggestion. I think this is best-suited as a [plugin](https://stylelint.io/developer-guide/plugins).
```
### Label as ready to implement
That fixes a bug in a rule:
```md
I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.
There are [steps on how to fix a bug in a rule](https://stylelint.io/developer-guide/rules#fix-a-bug-in-a-rule) in the Developer guide.
```
That adds a new option to a rule:
```md
I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.
There are [steps on how to add a new option](https://stylelint.io/developer-guide/rules#add-an-option-to-a-rule) in the Developer guide.
```
That adds a new rule:
```md
I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.
There are [steps on how to add a new rule](https://stylelint.io/developer-guide/rules#add-a-rule) in the Developer guide.
```
That is another type of improvement:
```md
I've labeled the issue as ready to implement. Please consider [contributing](https://stylelint.io/contributing) if you have time.
```
+33
View File
@@ -0,0 +1,33 @@
# Managing pull requests
You should:
- use [GitHub reviews](https://help.github.com/articles/about-pull-request-reviews/)
- review against the [Developer guide criteria](../developer-guide/rules.md)
- resolve conflicts by [rebasing](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase)
- assign _one or more_ [`pr: needs *`](https://github.com/stylelint/stylelint/labels) labels when requesting a change
You should not use:
- any other labels
- any milestones
## Merging
To merge a pull request, it must have at least:
- one approval for simple documentation fixes
- two approvals for everything else
When merging a PR, you should:
1. ["Squash and merge"](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#squash-and-merge-your-pull-request-commits) commits and ensure the resulting commit message is:
- descriptive
- sentence case
2. Update the [changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md) directly via the [GitHub website](https://github.com/stylelint/stylelint/edit/master/CHANGELOG.md) for everything except refactoring and documentation changes:
1. Create a `## Head` heading if one does not exist already.
2. Prefix the item with either: "Removed", "Changed", "Deprecated", "Added", or "Fixed".
3. Order the item within the group by the widest-reaching first to the smallest, and then alphabetically by rule name.
4. Suffix the item with the relevant pull request number, using the complete GitHub URL so that it works on [the website](https://stylelint.io/CHANGELOG/).
5. If applicable, lead the item with the name of the rule, e.g. "Fixed: `unit-disallowed-list` false positives for SCSS nested properties".
3. Post this update as a comment to the pull request.
+47
View File
@@ -0,0 +1,47 @@
# Performing releases
1. Create a [new issue](https://github.com/stylelint/stylelint/issues/new) announcing the planned release, e.g. `Release 8.11.1` and include the [template checklist](#new-release-issue-template).
2. Locally test `master` in the `stylelint-config-*` shareable config repositories. Install current `master` branch (`npm install stylelint/stylelint#master`) and run tests.
3. Locally test `master` in the [stylelint/stylelint.io](https://github.com/stylelint/stylelint.io) repository.
4. Locally test `master` in the [stylelint/stylelint-demo](https://github.com/stylelint/stylelint-demo) repository.
5. Publish the package to npm and create a GitHub release using [`np`](https://github.com/sindresorhus/np):
1. [Consistently format](pull-requests.md) the [changelog](../../CHANGELOG.md).
2. Replace `## Head` with new version number e.g. `## 8.1.2`.
3. Commit these changes.
4. Push these changes.
5. Confirm the changes are correct at [https://github.com/stylelint/stylelint](https://github.com/stylelint/stylelint).
6. Run `npm run release`.
7. Select the version that matches the one from the changelog.
8. Copy and paste the changelog entries for the published version from [changelog](../../CHANGELOG.md) when the GitHub release page opens.
9. Confirm the publishing of the package to [https://www.npmjs.com/package/stylelint](https://www.npmjs.com/package/stylelint).
10. Confirm the creation of the release at [https://github.com/stylelint/stylelint/releases](https://github.com/stylelint/stylelint/releases).
6. If a new version of any `stylelint-config-*` is required, repeat step 5 for that repository.
7. Update the online demo by changing to the `stylelint-demo` repository:
1. Run `npm install -S stylelint@latest`.
2. Run `npm test`.
3. Commit these changes.
4. Push these changes.
5. Confirm the deployment of the update to [stylelint.io/demo](https://stylelint.io/demo).
8. Update the website documentation by changing to the `stylelint.io` repository:
1. Run `npm install -D stylelint@latest`.
2. Run `npm test`.
3. Commit these changes.
4. Push these changes.
5. Confirm the deployment of the update to [stylelint.io](https://stylelint.io).
9. Compose a tweet that:
- announces the release
- communicates what has changed
- links to the appropriate heading in the changelog on [stylelint.io](https://stylelint.io).
## New release issue template
```markdown
- [ ] stylelint release
- [ ] stylelint-config-recommended update/release
- [ ] stylelint-config-standard update/release
- [ ] stylelint-demo update
- [ ] stylelint.io update
- [ ] tweet
cc @stylelint/core
```