-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
54 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- | ||
Thanks for Opening a Pull Request! | ||
I appreciate your time and effort to contribute to this project. | ||
Please complete the TODO items below and provide as much information as needed to help me understand your changes. | ||
If you would like collaboration feel free to open a draft & ask for help or feedback. | ||
--> | ||
|
||
## Description | ||
|
||
## Checklist | ||
|
||
- [ ] I have read the [CONTRIBUTING](https://github.com/JHWelch/MMM-CTA/blob/main/CONTRIBUTING) document | ||
- [ ] I have updated the documentation as needed | ||
- [ ] I have added/updated tests to cover my changes | ||
|
||
## Notes for Reviewers |
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,35 @@ | ||
# Contributing | ||
|
||
Thanks for Considering a Contribution! | ||
|
||
I appreciate your time and effort to contribute to this project. | ||
|
||
If you would like collaboration feel free to open a draft PR & ask for help or feedback. | ||
|
||
## Workflows | ||
|
||
This project uses GitHub Actions to automate the testing and deployment of the project. The workflows are defined in the `.github/workflows` directory. | ||
|
||
Your contributions must pass all the tests and workflows before they can be merged. | ||
|
||
Many linting problems can be automatically fixed by running | ||
|
||
```sh | ||
npm run fix | ||
``` | ||
|
||
## Testing | ||
|
||
In an effort to keep this project maintainable, we require all contributions to modify tests to cover the changes. | ||
|
||
Tests are written with [Jest](https://jestjs.io/) and are located in `__tests__`. | ||
|
||
They can be run with | ||
|
||
```sh | ||
npm test | ||
``` | ||
|
||
## Any questions? | ||
|
||
If you have questions about anything, please open an issue or a draft PR to discuss your concerns. I would be happy to assist you in getting your changes working. |