ghaction-github-pages/.github/CONTRIBUTING.md

## Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).

## Submitting a pull request

1. [Fork](https://github.com/crazy-max/ghaction-github-pages/fork) and clone the repository
2. Configure and install the dependencies: `yarn install`
4. Create a new branch: `git checkout -b my-branch-name`
5. Make your change
6. Run pre-checkin: `yarn run pre-checkin`
7. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-github-pages/compare)
8. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

- Make sure the `README.md` and any other relevant **documentation are kept up-to-date**.
- We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
Add CONTRIBUTING.md 2019-10-23 20:22:04 +08:00			`## Contributing`

			`Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.`

			`Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).`

			`## Submitting a pull request`

			`1. [Fork](https://github.com/crazy-max/ghaction-github-pages/fork) and clone the repository`
Switch to Yarn 2020-06-11 04:14:24 +08:00			2. Configure and install the dependencies: `yarn install`
Add CONTRIBUTING.md 2019-10-23 20:22:04 +08:00			4. Create a new branch: `git checkout -b my-branch-name`
			`5. Make your change`
Switch to Yarn 2020-06-11 04:14:24 +08:00			6. Run pre-checkin: `yarn run pre-checkin`
Use ncc 2020-04-09 06:59:11 +08:00			`7. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-github-pages/compare)`
			`8. Pat your self on the back and wait for your pull request to be reviewed and merged.`
Add CONTRIBUTING.md 2019-10-23 20:22:04 +08:00
			`Here are a few things you can do that will increase the likelihood of your pull request being accepted:`

			- Make sure the `README.md` and any other relevant documentation are kept up-to-date.
			`- We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.`
			`- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.`
			`- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).`

			`## Resources`

			`- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)`
			`- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)`
			`- [GitHub Help](https://help.github.com)`