actions/setup-beam
1
0
Fork 0
mirror of https://github.com/erlef/setup-beam.git synced 2026-07-22 22:56:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweak markdownlint rules and README versioning (#286)

Browse Source
This commit is contained in:
Paulo F. Oliveira
2024-06-16 03:13:54 +01:00
committed by GitHub
parent 8fd1f5cd6e
commit 54e90d44b0
5 changed files with 70 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+11 -6
View File
@@ -1,15 +1,18 @@
<!-- markdownlint-disable MD013 -->
# 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.
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).
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.
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
@@ -23,13 +26,15 @@ Please note that this project is released with a [Contributor Code of Conduct][c
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.
- 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.
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`