Skip to content

Commit a93ad1a

Browse files
committed
docs: added contributing guidelines
1 parent 8d0b8f2 commit a93ad1a

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish
4+
to make via an issue. Please use the issue templates. They are there to help you
5+
and the maintainers gather information.
6+
7+
If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you. If an issue is not assigned, it is assumed to be available for anyone to work on. Please assign yourself to an issue before working on it to avoid conflicts.
8+
9+
When creating a PR, please fill out the template to the best of your abilities.
10+
Maintainers are there to help you, so reach out via a comment in your PR.
11+
12+
Tests, formatting, and linting are run anytime you commit code in your working
13+
environment, e.g. your computer or Gitpod. Linting and tests also run on builds.
14+
If you have failing tests or linting issues and are unsure what to do, contact
15+
maintainers via your PR or the issue you are working on.
16+
17+
Please note we have a [Code of Conduct](CODE-OF-CONDUCT.md); follow it in all
18+
your interactions with the project.
19+
20+
And lastly, remember to have fun!

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ open http://localhost:3000
1515
## Development Environment
1616

1717
To get up and running with your development environment, see the [Development Guide](./docs/DEVELOPMENT_SETUP.md).
18+
19+
## Contributing
20+
21+
Interested in contributing to the project? Check out the [Contributing guidlines](./CONTRIBUTING.md) and remember to respect the [Code of Conduct](./CODE-OF-CONDUCT.md).

0 commit comments

Comments
 (0)