Skip to content

Latest commit

聽

History

History
80 lines (52 loc) 路 3.02 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) 路 3.02 KB
Raw

Contributing to Gravitee.io

You think Gravitee.io is awesome, and you'd like to contribute? Here are some guidelines that should help you get started.

Using GitHub issues

We use GitHub issues to track bugs and enhancements. Found a bug in the source code? Want to propose new features or enhancements? You can help us by submitting an issue in the repository.

Providing the following information will help us deal quickly with your issue:

  • Overview of the issue : describe the issue and why this is a bug for you.
  • UI Particles version(s) : possible regression?
  • Browsers and Operating System : Linux/Windows/Docker? Browser version for the UI, etc ...
  • You have stack trace, screenshots, logs ? add these to the issue's description.

Setup

This repository is using Yarn workspaces., so you need to have Yarn installed to contribute, see Yarn's installation guide.

Submitting changes

You've submitted an issue to the project and know how to fix it? You can contribute to the project by forking the repository and submitting your pull requests.

Before submitting your pull request consider the following guidelines:

  • Make your changes in a new git branch:
git checkout -b issue-<issue-id>-my-fix-branch main
Note : issue-id reference the id generated by GitHub (#issue-id).
  • Create your patch, including appropriate test cases.
  • Update the documentation if you create new features or think the documentation needs to be updated/completed.
  • Build your changes locally to ensure all the linters rules and tests pass
yarn lint
yarn test
  • Commit your changes using a descriptive commit message.
 git commit -a
  • Push your branch to GitHub:
git push origin issue-<issue-id>-my-fix-branch

  • In GitHub, send a pull request to <gravitee-io/gravitee-ui-particles>:main.

  • If we suggest changes then: ** Make the required updates. ** Re-run the test suite to ensure tests are still passing. ** Commit your changes to your branch (e.g. issue/<issue-id>-my-fix-branch). ** Push the changes to your GitHub repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git rebase main
git push origin issue-<issue-id>-my-fix-branch -f

That's it! You've just contributed to the project, and we really appreciate it!

Contributor License Agreement

Please sign our Contributor License Agreement (CLA) and send it to contact@graviteesource.com. For any code changes to be accepted, the CLA must be signed.

Further Information

You can find more detailed information about contributing in the GitHub guides.