mirror/goaway
1
0
Fork 0
mirror of https://github.com/pommee/goaway.git synced 2025-12-30 10:29:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: add contributions page

Browse Source
This commit is contained in:
pommee
2025-10-07 16:46:37 +02:00
parent 57bbbe04d7
commit 86d64bc32b
2 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,14 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via an issue with the owners of this repository before making any changes. Once the details has been cleared and an approval is given by a project maintainer, either you or the maintainer starts with an implementation.
### Standards for contributions
- Your reported issue has been approved by a project maintainer to be implemented.
- All commits must be semantic, [read more here](https://www.conventionalcommits.org/en/v1.0.0/). You can find the accepted types [here](https://github.com/pommee/goaway/blob/main/.releaserc.json).
- Tests, linting of server/client code and commits must all pass.
### Our Responsibilities
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions, or to temporarily/permanently ban any contributor for other behaviors that can be deemed unfitting.

2
README.md
View File

@@ -217,7 +217,7 @@ Contributions are welcomed! Here's how you can help:
1. **Report Issues:** Found a bug? [Create an issue](https://github.com/pommee/goaway/issues/new?template=bug_report.md)
2. **Request Features:** Have an idea? [Start a discussion](https://github.com/pommee/goaway/discussions) or create a [feature request](https://github.com/pommee/goaway/issues/new?template=feature_request.md)
3. **Submit PRs:** Before any work is started, create a new issue explaining what is wanted, why it would fit, how it can be done, so on and so forth...
Once the topic has been discussed with a maintainer then either you or a maintainer starts with the implementation. This is done to prevent any collisions, save time and confusion.
Once the topic has been discussed with a maintainer then either you or a maintainer starts with the implementation. This is done to prevent any collisions, save time and confusion. [Read more here](./CONTRIBUTING.md)
## ⚠️ Platform Support