mirror of
https://github.com/erlef/setup-beam.git
synced 2026-07-23 15:16:08 +00:00
Paulo F. Oliveira
47 lines
2.0 KiB
Markdown
47 lines
2.0 KiB
Markdown
# Contributing
|
|
|
|
[fork]: https://github.com/erlef/setup-beam/fork
|
|
[pr]: https://github.com/erlef/setup-beam/compare
|
|
[code-of-conduct]: https://github.com/erlef/setup-beam/blob/main/CODE_OF_CONDUCT.md
|
|
|
|
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.md).
|
|
|
|
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By
|
|
participating in this project you agree to abide by its terms.
|
|
|
|
## Submitting a pull request
|
|
|
|
1. [Fork][fork] and clone the repository
|
|
1. Configure and install the dependencies: `npm install`
|
|
1. Create a new branch: `git checkout -b my-branch-name`
|
|
1. Make your change, add tests, and make sure the tests still pass
|
|
1. Push to your fork and [submit a pull request][pr]
|
|
1. 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:
|
|
|
|
- Write tests.
|
|
- 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).
|
|
- Execute `npm run build-dist` and fix any issues arising from that
|
|
|
|
## Running tests
|
|
|
|
When running tests locally, a valid classic GitHub token with the `repo` scope is required for tests
|
|
to pass.
|
|
|
|
- Export the token in the current shell: `export GITHUB_TOKEN=<contents>`
|
|
- Run tests `npm test`
|
|
|
|
## 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)
|