-
Notifications
You must be signed in to change notification settings - Fork 14
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
CONTRIBUTING.md #33
Comments
Now, in each repo, let's:
I'm updating the issue description with the repositories list. |
We should replace the '⚙️ Development Workflow' section in every readme to something like: ⚙️ Development Workflow and ContributingAny new contribution is more than welcome in this project! If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions! |
All the SDKs have a CONTRIBUTING.md now, closing then! |
It's been a long time I'm thinking about adding a CONTRIBUTING.md file, especially when I saw @erlend-sh was starting the PR for the MeiliSearch repository.
The goal of this file is to:
Of course, I took most of my inspiration in the Erlend's PR but I tried to take into account the Kero remark: not to provide a too long file that could discourage some contributors. The
Development Worklow
needs to be detailed and accurate of course since it's mandatory to work. But I tried to make theGit Guidelines
simple (and that's why I put it to the end of the file). As we are beginners in the OS community, I would rather a contributor who contributes but we need to redirect him/her to the CONTRIBUTING.md, that no contribution at all.The goal here is to make it simple with no complexe rules, but to give a base and a reference to our contributors. Thus, and since the rules are really easy to follow, if you notice a contributor that does not follow the guidelines, don't hesitate to redirect him to the CONTRIBUTING.md file (nicely of course 😇).
As it's not convenient at all to discuss together about a CONTRIBUTING.md template here, I'm going to create a PR that everyone is welcome to review 😉the PR #34 is merged now.Edit
Here is the final contributing template.
In every repository READMEs, we need to:
Development Workflow
section in the README and replace it by this section CONTRIBUTING.md #33 (comment)Todo:
The text was updated successfully, but these errors were encountered: