Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
JHWelch authored Feb 18, 2024
2 parents 53e77f6 + 9543ff3 commit 5824212
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
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
35 changes: 35 additions & 0 deletions CONTRIBUTING
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.

0 comments on commit 5824212

Please sign in to comment.