Skip to content

Commit

Permalink
docs: added contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
nickytonline committed Jan 4, 2025
1 parent 8d0b8f2 commit a93ad1a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing

When contributing to this repository, please first discuss the change you wish
to make via an issue. Please use the issue templates. They are there to help you
and the maintainers gather information.

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.

When creating a PR, please fill out the template to the best of your abilities.
Maintainers are there to help you, so reach out via a comment in your PR.

Tests, formatting, and linting are run anytime you commit code in your working
environment, e.g. your computer or Gitpod. Linting and tests also run on builds.
If you have failing tests or linting issues and are unsure what to do, contact
maintainers via your PR or the issue you are working on.

Please note we have a [Code of Conduct](CODE-OF-CONDUCT.md); follow it in all
your interactions with the project.

And lastly, remember to have fun!
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,7 @@ open http://localhost:3000
## Development Environment

To get up and running with your development environment, see the [Development Guide](./docs/DEVELOPMENT_SETUP.md).

## Contributing

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 comments on commit a93ad1a

Please sign in to comment.