-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re update
- Loading branch information
Showing
79 changed files
with
3,747 additions
and
983 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Contributing | ||
|
||
## Releasing Preact | ||
|
||
This guide is intended for core team members that have the necessary | ||
rights to publish new releases on npm. | ||
|
||
1. [Write the release notes](#writing-release-notes) and keep them as a draft in GitHub | ||
1. I'd recommend writing them in an offline editor because each edit to a draft will change the URL in GitHub. | ||
2. Make a PR where **only** the version number is incremented in `package.json` (note: We follow `SemVer` conventions) | ||
3. Wait until the PR is approved and merged. | ||
4. Switch back to the `master` branch and pull the merged PR | ||
5. Run `npm run build && npm publish` | ||
1. Make sure you have 2FA enabled in npm, otherwise the above command will fail. | ||
2. If you're doing a pre-release add `--tag next` to the `npm publish` command to publish it under a different tag (default is `latest`) | ||
6. Publish the release notes and create the correct git tag. | ||
7. Tweet it out | ||
|
||
## Legacy Releases (8.x) | ||
|
||
> **ATTENTION:** Make sure that you've cleared the project correctly | ||
> when switching from a 10.x branch. | ||
0. Run `rm -rf dist node_modules && npm i` to make sure to have the correct dependencies. | ||
|
||
Apart from that it's the same as above. | ||
|
||
## Writing release notes | ||
|
||
The release notes have become a sort of tiny blog post about what's | ||
happening in preact-land. The title usually has this format: | ||
|
||
```txt | ||
Version Name | ||
``` | ||
|
||
Example: | ||
|
||
```txt | ||
10.0.0-beta.1 Los Compresseros | ||
``` | ||
|
||
The name is optional, we just have fun finding creative names :wink: | ||
|
||
To keep them interesting we try to be as | ||
concise as possible and to just reflect where we are. There are some | ||
rules we follow while writing them: | ||
|
||
- Be nice, use a positive tone. Avoid negative words | ||
- Show, don't just tell. | ||
- Be honest. | ||
- Don't write too much, keep it simple and short. | ||
- Avoid making promises and don't overpromise. That leads to unhappy users | ||
- Avoid framework comparisons if possible | ||
- Highlight awesome community contributions (or great issue reports) | ||
- If in doubt, praise the users. | ||
|
||
After this section we typically follow with a changelog part that's | ||
divided into 4 groups in order of importance for the user: | ||
|
||
- Features | ||
- Bug Fixes | ||
- Typings | ||
- Maintenance | ||
|
||
We generate it via this handy cli program: [changelogged](https://github.com/marvinhagemeister/changelogged). It will collect and format | ||
the descriptions of all PRs that have been merged between two tags. | ||
The usual command is `changelogged 10.0.0-rc.2..HEAD` similar to how | ||
you'd diff two points in time with git. This will get you 90% there, | ||
but you still need to divide it into groups. It's also a good idea | ||
to unify the formatting of the descriptions, so that they're easier | ||
to read and don't look like a mess. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,6 @@ | |
"regex": "^_" | ||
}, | ||
"peerDependencies": { | ||
"preact": "^10.0.0-alpha.0" | ||
"preact": "^10.0.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.