Vuepress: Create CONTRIBUTING.md

Created on 6 Aug 2019  路  2Comments  路  Source: vuejs/vuepress


Feature request

We need to create a CONTRIBUTING.md guide.
Original idea from #1745 and #1741



What problem does this feature solve?

It allows new contributors to understand the process of creating new PRs to the repo.
Ideally, it covers topics like:

  1. Forking and branching, including branch names and commit messages
  2. Project and mono-repo layout
  3. Code quality standards and agreements
  4. CI process and how to fix it
  5. Common tips that we know about

Are you willing to work on this yourself?

I would better ask for help of someone who works on this repo for a longer period of time.
And knows all the conventions and tools.

help wanted docs enhancement

Most helpful comment

Hey! @ulivz created one already, let's finish it :) https://github.com/vuejs/vuepress/pull/1739

All 2 comments

Hey! @ulivz created one already, let's finish it :) https://github.com/vuejs/vuepress/pull/1739

I am closing this one because the #1739 is merged feel free to re open it if you think it should not be close

Was this page helpful?
0 / 5 - 0 ratings

Related issues

zeke picture zeke  路  3Comments

higuoxing picture higuoxing  路  3Comments

FadySamirSadek picture FadySamirSadek  路  3Comments

shaodahong picture shaodahong  路  3Comments

gaomd picture gaomd  路  3Comments