Add contributing guide #422
Conversation
pierre-eliep-met
added
the
📝documentation
pierre-eliep-met
added
the
🗃️skip-changelog
| - **Do not attach sensitive data to the GitHub issue you create** | ||
| - Pick the appropriate template (bug report or feature request) and fill it with your issue details | ||
|
|
||
| ## You know how to fix a bug / add a new feature ? |
There was a problem hiding this comment.
Is this part internal or external use?
If someone outside of the team wants to suggest a PR, we would be doing the reviewing and the merging. I think we need to take the time to think of what external contributors will and will not be able to do with the repo. Do you know what are the good practices for open source repos?
There was a problem hiding this comment.
I think the most standard permission for external users is Triage (see the detailed permissions here), basically you can create issues, but not apply any modifications to the code yourself (can't push, can't merge, etc.)
Notably, with Triage permissions you need to fork the repo so that you have a copy of the existing repo with write access, do the dev on your local repo, then create a PR to original repo
There was a problem hiding this comment.
If you want a user to be able to create a branch and PR on the MML repo, you have to give write access, meaning a lot of things, almost as much as any process team member
There was a problem hiding this comment.
But if we have the high enough paid plan, we can create our own role
Goal
Adds a contributing guide to MML
Type of change
package.mo)Will it break anything in previous models ?
Checklist
You can also fill these out after creating the PR, but make sure to check them all before submitting your PR for review.