devrel icon indicating copy to clipboard operation
devrel copied to clipboard

Contributing suggestion of improvements

Open curquiza opened this issue 2 years ago • 6 comments

Hello @meilisearch/devrel-team 👋 Here is a suggestion for contributing improvements to avoid this kind of issue we sometimes have: https://github.com/meilisearch/documentation/issues/1882, https://github.com/meilisearch/meilisearch-kubernetes/issues/129

My suggestion is to

  • update the default template for PRs, see my draft PR here https://github.com/meilisearch/.github/pull/11
  • update our current CONTRIBUTING.md to be more permissive and let people create PRs without creating necessarily issues for not-really-impactful changes like typo fixes. We can also add a warning a creating a PR without any approval for the change can be closed.

Currently, we sometimes have double notifications for not really important changes. But most of all, I think it's important to remove the maximum of steps to let people contribute since we are not flooded by contributions yet. Closing PRs is of course something we allow.

I would love to have your opinion @dichotommy @brunoocasali on this question.

curquiza avatar Sep 19 '22 09:09 curquiza

I liked the idea @curquiza, and yeah, reducing the notifications burden is something I appreciated ❤️

brunoocasali avatar Sep 19 '22 10:09 brunoocasali

This is a really great idea! Especially with Hacktoberfest coming up!

shivaylamba avatar Sep 19 '22 10:09 shivaylamba

Thanks for starting the discussion @curquiza . I love the idea of removing any additional steps which are not super required.

I'm wondering how we could explain that contributors can sometimes skip the usual process: where to communicate about it and what to say? And also what are the criteria to determine if they can skip the process?

ferdi05 avatar Sep 19 '22 14:09 ferdi05

I'm wondering how we could explain that contributors can sometimes skip the usual process: where to communicate about it and what to say? And also what are the criteria to determine if they can skip the process?

Indeed, this is the part that is not easy to describe in the CONTRIBUTING... I can try something, open a PR, and make you in review?

curquiza avatar Sep 19 '22 15:09 curquiza

sure, happy to help if I can

ferdi05 avatar Sep 19 '22 15:09 ferdi05

Hello, I'm late to the party, but I agree with both of your suggestions @curquiza . Fewer notifications for us and fewer barriers for contributors, what's not to like! Happy to review once a PR has been created for the contributing guide.

dichotommy avatar Oct 24 '22 09:10 dichotommy