Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #456

Open
4rgon4ut opened this issue Sep 20, 2024 · 0 comments
Open

Add CONTRIBUTING.md #456

4rgon4ut opened this issue Sep 20, 2024 · 0 comments

Comments

@4rgon4ut
Copy link
Contributor

Adding more direct style/flow instructions for contributors will be beneficial for the project. Current README is quite direct and clear but it lacks some flow bits, proposed document intended to add this missing information and simplify contributions for newcomers:

Guide:
https://gist.github.com/4rgon4ut/e885ae04dddc0dfb632e8597d70494ed
Useful optionals listed in OPTIONALS.md and may be added if necessary

I was trying to not duplicate readme so guide is pretty simple and it would be nice to hear some thoughts from maintainers.
I have some questions:

  1. Should we enforce issue creation? ie. creation of issue is always required before the PR
  2. I see no versioned release yet, should we add versioning mention? (semver?)
  3. Your overall thoughts on styling the the doc (branching/commits convention)

This may probably be simplified even further and become a part of a README btw

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant