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

Add CONTRIBUTING.md #3

Open
twolfson opened this issue Jan 1, 2016 · 1 comment
Open

Add CONTRIBUTING.md #3

twolfson opened this issue Jan 1, 2016 · 1 comment
Assignees

Comments

@twolfson
Copy link
Contributor

twolfson commented Jan 1, 2016

Since we are going to be adding this to a shared organization, we should probably add a CONTRIBUTING.md which would include:

  • Preferred workflow
  • Release process
@twolfson
Copy link
Contributor Author

The current release process has been listed in #24 (comment)

  • Determine whether this is a major, minor, or patch release
  • Run npm version with release type
    • For example: npm version patch for a patch release
    • This will increment the package.json version, create a new git commit, and create a new git tag
  • Run npm publish to publish to npm
  • Run git push && git push --tags to publish to GitHub

To put it altogether:

npm version {{version_type}}
npm publish
git push
git push --tags

@chrismou chrismou self-assigned this Jul 23, 2016
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

No branches or pull requests

2 participants