Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 1.99 KB
Raw

Contributing

Contributors are welcome!

See something that needs fixing? Got an idea for a new feature? Contribute a Pull Request!

Easy path to contribution

Click the Gitpod badge to setup a ready to code dev env in the cloud.

Gitpod Ready-to-Code

Standard path to contribution

Prerequisites / Setup

  1. Fork the repo

    # The clone your copy
git clone <forked-repo>

  2. Install the dependencies

    # From the project directory, run
npm i

Be Create a Pull Request once you've written you code.

Run the tests

  1. Run the tests

    npm test

Develop

  • Write code
  • Add tests to validate new behaviors
  • Ensure all tests succeed
  • Create a PR
  • Have fun!

Create a Pull Request

  1. Fork it

  2. Clone it to your local system

  3. Make a new branch

  4. Make your changes

  5. Push it back to your repo

  6. From the Github UI, Click the Compare & pull request button

    NOTE: this button will be present for some period of time after 5. If the button no longer there, Create pull request and select the branches manually)

  7. From the Github UI, Click Create pull request to open a new pull request

  8. Detailed steps with example here:

Project structure

src contains the source code test contains the tests

Need help?

Create an issue with type 'question'

We're happy to help!

FAQ

Q: I don't have permission to create a branch and I can't push my changes

A: You cannot directly create a branch in this repo. Instead Create a Pull Request

Misc

If you are not a project, you may ignore this section

Generate Change Log

Run the following each time a release is cut.

npm install -g conventional-changelog-cli
conventional-changelog -p mongo-serdes-js -i CHANGE_HISTORY.md -s

Thanks!