Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

41 lines (33 loc) · 1.93 KB
Raw

🤝 Contributing

Thank you for reading the contribution guide. Your help is appreciated ❤️

What you can do

There are many ways to contribute with this project, but we can divide it in two groups: contributing with code and with docs or other things.

  • 👉 Contributing With Code
    • Creating new features
    • Fixing bugs
    • Fixing typos in code
    • Refactoring code
    • Improving organization
  • 👉 Contributing With Docs or Other Things
    • Improving the documentation
    • Fixing typos in documentation
    • Helping other people to use the library
    • Sharing this library with people you know
    • Staring the project on GitHub

How to contribute with code

👇 Basically you have to do the steps below: 👇

  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch from the master branch to work on!
  • Make the changes you want in the code.
  • Run the dev script from the package.json.
  • Open the src/index.html file in the browser and test manually to make sure that everything still works.
  • Run tests using the test script.
  • Write or adapt tests as needed.
  • Add or change the documentation as needed.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the master branch from the original.
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.