-
Notifications
You must be signed in to change notification settings - Fork 4
Update Contribution Documentation #86
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
base: main
Are you sure you want to change the base?
Conversation
@codello thanks for all the work. This is a really professional contribution. I actually agree with all changes: Contribution Guide, Code of Conduct, ReadMe and Issue Templates ✅ If I remember where we started with the format project in 2023 this is definitely an improvement in many ways. I hope that there will be soon enough discussion and feedback. I'd like to see this PR merged in May. |
I’d like to propose that we keep the website in the main branch instead. Here’s why:
Open to refining the workflow further, but I think keeping the website on main is the most practical and transparent approach. Personally, I think that if a decision has been made and it results in a new revision of the documents, any required changes to the website should be included in the same change. Preferably, the website won’t need updating at all and can just reference the correct version files — but that’s something to be addressed further in #41. Happy to hear thoughts, but I think keeping everything on main offers the clearest and most maintainable workflow. |
The contribution guide explains the basic development process of the repository and how new users can contribute to the file format. The README is updated to reflect these new processes.
Issue templates help create more helpful issues for common scenarios. Instead of using generic templates this commit adds templates specifically for this project.
I finally found the time to revisit this PR. I'm sorry for the delay. I'm marking this PR as ready for review now. Those are very good points @Baklap4. Especially Clearer for contributors is very convincing. I have updated the PR accordingly. The latest state of the PR includes a different proposal:
What do you think of that? This could be semi-automated via GitHub Actions by automatically creating a PR from A somewhat related open question is that I would really like to be able to publish different versions of the spec independently of each other. I don't have a good solution for that yet, but maybe this isn't as much of a problem as I think |
What does this PR do?
This PR updates the documentation and tools to help people make better contributions to this project. This includes:
CONTRIBUTING.md
guideCloses Issue(s)
None, but #85 is related.
Motivation
The subject of issue templates has come up in #73. In order to help new contributors understand the processes in this repo I also started to write a contribution guide.
Additional Notes
In the current state this PR contains changes that are still under active discussion in #85.