Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

71 lines (55 loc) · 3.78 KB
Raw

How to contribute

❗ Common mistakes

  • Opening a pull request without a description or a proper name is not fun for the reviewer, so try to explain your change as much as possible either by text or a code snippet.
  • Adding new dependencies or modifying the package.json will most likely be not accepted or will be accepted in a long time since adding a new dependency to the codebase can be tricky.
  • This project uses npm, so please try to respect the choice and try to use it.

📝 Useful scripts

These are the useful scripts that you can use while developing. You can find them in the package.json file. You can run them by using npm run <script_name>.

Script Description
dev Start the development environment
build Test and build the app and the live-demo
build:live-demo Only build the live-demo
preview Run the app on preview mode
generate:types Generate all the types for the project
changeset Adds a changelog to the project after a change
test Run the tests once
test:watch Watch the tests
test:no-broker Run the tests excluding the broker tests
test:no-broker:watch Watch the tests excluding the broker tests
test:coverage Create a coverage report for the tests

When pushing your changes, always include a changeset file. You can do this by running the changeset script. It will ask you a few questions and then create a file for you. You can read more about it here.

🐛 Did you find a bug?

Ensure the bug was not already reported by searching on GitHub under Issues. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible demonstrating the expected behavior that is not occurring.

💡 Do you want to add a new feature or change an existing one?

Open a GitHub issue stating your feature request clearly. We can discuss it on the issue thread, then you can implement it! 🎉

✨ Did you write a change that fixes a bug?

Open a new GitHub pull request with the patch.

  1. Fork the repository
  2. Modify the code and make your amazing change
  3. Create your feature branch 
    git checkout -b feature/<your_feature>
  4. IMPORTANT! If your code contains minor or a major change that needs to be stated on the changelog, please run the command below and write down what you have changed in a brief manner. 
    npm run changeset
  5. Add your changes 
    git add .
  6. Commit your changes (please respect the commit message standards) 
    git commit -m "feat: added amazing things!"
  7. Push your changes 
    git push -u origin feature/<your_feature>
  8. Open a pull request from your branch
    • State your change in the title according to the conventional commit guidelines.
    • Please respect the pull request template while writing your PR description.

Open source software is beautiful, all of your contributions are much appreciated

Thanks!

This guideline was inspired by the Ruby on Rails team