Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

50 lines (40 loc) · 3.14 KB

Contributing to DragDoll

Thanks for the interest in contributing to DragDoll! Here you will find some instructions on how to create an issue or a pull request.

Creating an issue

Questions

First of all you should check out the existing questions and see if your question has been asked/answered already. If not, you can create a new issue and explain the problem you're facing.

Improvements

Improvement ideas are always welcome! Please check first the existing ideas, features and enhancements so that you won't be creating a duplicate issue.

Bugs

Please create an issue and explain the bug in detail. If possible create a reduced test case and share a link to it.

Creating a pull request

  1. Discuss first.
    • The first step should always be creating a new issue and discussing your pull request suggestion with the authors and the community.
    • After you get green light it's time to get coding.
  2. Fork the repo and create a new branch for your pull request.
    • Fork DragDoll.
    • Create a new branch for your pull request from the master branch. The name of the pull request branch should start with the id of the issue you opened for the pull request, e.g. #123-fix-something.
  3. Setup the development environment.
    • Run npm ci in the root.
    • You can now run the following commands:
      • npm run build
        • Builds the distributable files from src directory into the dist directory.
      • npm run format
        • Formats all files in src directory with Prettier.
      • npm run lint
        • Lints all files in src directory with Prettier and validates TS types.
      • npm run test
        • Runs unit tests in Browserstack.
        • To make this work you need to create an .env file the project root, which should contain BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY variables.
      • npm run test-local
        • Runs unit tests locally in Chrome and Firefox. You have to have them both installed.
  4. Do the updates.
    • Remember scope. Don't refactor things that are not related to the pull request.
    • After you're done update unit tests and docs (README.md) if necessary.
  5. Build and test changes.
    • Run npm run build to build the lib with the changes and npm run test to make sure the changes didn't cause regressions.
  6. Create the pull request.
    • Do your best to explain what the pull request fixes.
    • Mention which issue(s) will be closed by the pull request, e.g. Closes #123.
    • Request a review from @niklasramo.
  7. You made it! Thank you so much for contributing to DragDoll!