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

docs: update contributing guide #2475

Merged
merged 4 commits into from
Jul 19, 2020
Merged

Conversation

bencodezen
Copy link
Member

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:


Good from here you have everything ready. You need to link VuePress to your project.
# Initalize a new npm project
npm init
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be nice to mention yarn init as an alternative too :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion! Just added it

Copy link
Collaborator

@billyyyyy3320 billyyyyy3320 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bencodezen Please check out CONTRIBUTING.md. I believe they should be sync(or only keep one of them).

Copy link
Collaborator

@kefranabg kefranabg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! agreed with @billyyyyy3320, we should update the CONTRIBUTING.md as well

@ulivz
Copy link
Member

ulivz commented Jul 19, 2020

Yes, we should update the CONTRIBUTING.md as well, but merging this Pull Request first is also OK.

@ulivz ulivz merged commit 823c1df into master Jul 19, 2020
larionov pushed a commit to larionov/vuepress that referenced this pull request Aug 19, 2020
* docs: update contributing guide

* docs: add yarn init option

* fix: markdown linting errors
@meteorlxy meteorlxy deleted the docs/update-contribution-guide branch January 26, 2021 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants