Skip to content

Latest commit

 

History

History
53 lines (43 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

53 lines (43 loc) · 3.69 KB
Raw

Contributing to Muuri

Thanks for the interest in contributing to Muuri! 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. You can, for example, fork this CodePen example and modify it to demonstrate the bug.

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 Muuri.
    • 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 install in the repository's directory.
    • You can now run the following commands:
      • npm run build
        • Builds dist/muuri.js and dist/muuri.min.js from src directory.
      • npm run lint
        • Lints all files in src directory with ESLint.
      • npm run format
        • Formats all files in src directory with Prettier.
      • npm run test
        • Runs unit tests for dist/muuri.js and dist/muuri.min.js files in Sauce Labs.
        • To make this work you need to create an .env file the project root, which should contain SAUCE_USERNAME and SAUCE_ACCESS_KEY variables.
        • Launches chrome, firefox and safari by default.
        • You can provide arguments to launch specific browsers: npm run test --chrome --firefox --safari --edge.
  4. Do the updates in src folder.
    • Now is the time to make the actual updates to Muuri.
    • 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.
    • Also, if this is your first pull request to Muuri remember to add yourself to the AUTHORS.txt file, e.g. John Doe <https://github.com/johndoe>.
  5. Format, build and test changes.
    • Run npm run format, npm run build and finally npm run test.
  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
    • After your pull request is accepted it will be merged to the dev branch and released with the next release. If you did only some minor change in the documentation it may be merged directly to the master branch.
  7. You made it! Thank you so much for contributing to Muuri!