Skip to content
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

Improve the CONTRIBUTING.md #51

Closed
curquiza opened this issue Oct 23, 2020 · 1 comment
Closed

Improve the CONTRIBUTING.md #51

curquiza opened this issue Oct 23, 2020 · 1 comment

Comments

@curquiza
Copy link
Member

curquiza commented Oct 23, 2020

The goal of this issue is to make the CONTRIBUTING.md less "heavy" for the contributors. Indeed, the more the file is big, the less they are going to read it.

Here is what I suggest:

  • the Release Process section was in the Development Workflow: I suggest to move it to a separated section and to specify this section concerns only the Administrators, I mean the Meili team. If the contributors are curious, they can read. If they don't care, they know they can skip this section.
  • Add a Bors related section, but the section is really small and redirects to the Bors guide I created: the goal is to mention it but not to make the CONTRIBUTING file too heavy. As this section only concerns the Meili team, adding a redirection is not impactful.
  • Make the Automated Changelogs section smaller: as for the Bors section, the purpose is to reduce the CONTRIBUTING.md file and to redirect to the release-drafter guide. See Add release-drafter guide #49.

I created a PR so that you can approve on it! #50

I know a lot other things could be improved, this is just the first steps of a general change 😉

@curquiza curquiza added the need approval A final choice is suggested label Oct 23, 2020
@curquiza curquiza added ready to implement and removed need approval A final choice is suggested labels Dec 31, 2020
bors bot added a commit to meilisearch/meilisearch-dotnet that referenced this issue Jan 5, 2021
88: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
bors bot added a commit to meilisearch/meilisearch-go that referenced this issue Jan 5, 2021
114: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
bors bot added a commit to meilisearch/meilisearch-python that referenced this issue Jan 5, 2021
192: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-js that referenced this issue Jan 5, 2021
730: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-php that referenced this issue Jan 5, 2021
125: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-rust that referenced this issue Jan 5, 2021
80: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/vuepress-plugin-meilisearch that referenced this issue Jan 5, 2021
89: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-swift that referenced this issue Jan 5, 2021
99: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-swift that referenced this issue Jan 5, 2021
99: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/docs-scraper that referenced this issue Jan 5, 2021
85: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-js-plugins that referenced this issue Jan 5, 2021
204: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-ruby that referenced this issue Jan 5, 2021
130: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
bors bot added a commit to meilisearch/meilisearch-js-plugins that referenced this issue Jan 5, 2021
204: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/docs-searchbar.js that referenced this issue Jan 5, 2021
192: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
bors bot added a commit to meilisearch/meilisearch-symfony that referenced this issue Jan 5, 2021
34: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/meilisearch-laravel-scout that referenced this issue Jan 5, 2021
69: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
bors bot added a commit to meilisearch/meilisearch-symfony that referenced this issue Jan 5, 2021
34: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
bors bot added a commit to meilisearch/vuepress-plugin-meilisearch that referenced this issue Jan 14, 2021
89: Restructure the CONTRIBUTING.md r=curquiza a=meili-bot

_This PR is auto-generated._

Related to this issue: meilisearch/integration-guides#51


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
@curquiza
Copy link
Member Author

Done!

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

No branches or pull requests

1 participant