Skip to content
This repository was archived by the owner on May 14, 2024. It is now read-only.

Contributing suggestion of improvements #492

Open
curquiza opened this issue Sep 19, 2022 · 6 comments
Open

Contributing suggestion of improvements #492

curquiza opened this issue Sep 19, 2022 · 6 comments

Comments

@curquiza
Copy link
Member

curquiza commented Sep 19, 2022

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

My suggestion is to

  • update the default template for PRs, see my draft PR here Update pull_request_template.md .github#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 curquiza changed the title Contributing suggestion Contributing suggestion of improvements Sep 19, 2022
@brunoocasali
Copy link
Member

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

@shivaylamba
Copy link
Contributor

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

@ferdi05
Copy link
Contributor

ferdi05 commented Sep 19, 2022

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?

@curquiza
Copy link
Member Author

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?

@ferdi05
Copy link
Contributor

ferdi05 commented Sep 19, 2022

sure, happy to help if I can

@dichotommy
Copy link
Contributor

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.

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

No branches or pull requests

5 participants