Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.48 KB
Raw

Contributing to node-mongo-tenant

✨🎉 Many thanks for contributing! 🎉✨

First of all

Any contribution is welcome. This project is committed to the following CODE OF CONDUCT.

How can I contribute?

  • Write some docs or tutorial
  • Start a discussion about a new feature
  • Report a bug
  • Submit a PR
  • Open an issue to give feedback
  • Write tests
  • Suggest updates to this document
  • ...

Contribution Guidelines

  • 👍 This project follows git flow
  • 👍 Releases are semanticly versioned
  • 👍 Code coverage should remain 100%
  • 👍 Changes should be stated in release-notes.yml

Creating a feature branch

For new features, or fixes that introduce new elements to the public API (such as new public methods or properties), issue the pull request against the "develop" branch.

$ git checkout develop
$ git fetch origin
$ git rebase origin/develop
$ git checkout -b feature/${ISSUE_NUMBER}
  • Write the changes to release-notes.yml underneath version: Unreleased

Creating a hotfix branch

For hotfixes against the stable release, issue the pull request against the "master" branch.

$ git checkout master
$ git fetch origin
$ git rebase origin/master
$ git checkout -b hotfix/${ISSUE_NUMBER}
  • Bump the version in package.json to the next patch level ("1.1.0" => "1.1.1").
  • State the new version's changes to release-notes.yml