Skip to content

Commit

Permalink
chore: Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: William Walker <w_walker@icloud.com>
  • Loading branch information
willswire authored Jan 23, 2025
1 parent d4eb466 commit c38bee2
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing

We want to make contributing to this project as easy and transparent as
possible.

## Pull Requests

We actively welcome your pull requests.

If you're new, we encourage you to take a look at issues that have been previously marked as resolved and have resulted in a successful merge.

### For new features

1. Create a GitHub issue proposing a new feature.
2. Fork the repo and create your branch from `main`.
3. If you've added code that should be tested, add tests to `test/index.spec.ts`.
4. Update the `README.md` and/or `docs/faq.md` where appropriate.
5. Ensure your test passes locally.
6. Address any feedback in code review promptly.

## Issues

We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue.

## License

By contributing to examples, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree.

0 comments on commit c38bee2

Please sign in to comment.