[Documentation] We need `CONTRIBUTING.md` - Githubissues

vaguecoder / gorilla-mux

A fork of gorilla/mux, the powerful HTTP router and URL matcher for building Go web servers with 🦍

http://www.gorillatoolkit.org/pkg/mux

BSD 3-Clause "New" or "Revised" License

1 stars 3 forks source link

[Documentation] We need `CONTRIBUTING.md` #11

Open vaguecoder opened 1 year ago

vaguecoder commented 1 year ago

What?

We need CONTRIBUTING.md for guidelines on contributing to this project. It should have detail on

What copyleft license is included (the original gorilla mux has BSD-3 and we are leaving it as is)
Every commit should be signed, and DCO bot checks for it, etc.
How to test in local before committing changes
Milestones and versioning
Issue types
Label types

Why?

As communication on issue/PR is hard, it is better to clarify a few things for contributors.

Additional Context

Samples:

Ownership of Contribution

If the triage is approved,

[ ] I wish to submit the PR myself.
[x] I wish to submit the PR. But if someone is willing to do it, go ahead.
[ ] I don't know how to fix this or make these changes. I wish others to pick this up for me.

vaguecoder commented 1 year ago

++ Details about CONTRIBUTING.md should be included in README.md