Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 3.28 KB

CONTRIBUTING.adoc

File metadata and controls

100 lines (69 loc) · 3.28 KB

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 our repository. Before submitting your issue, please search the issues archive to see if your question has already been answered.

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.

  • Gravitee.io 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.

Submitting changes

Have you 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 you submit your pull request consider the following guidelines:

  • Make your changes in a new git branch:

git checkout -b issue/<issue-id>-my-fix-branch master

Note : issue-id reference the id generated by GitHub.

  • Create your patch, including appropriate test cases.

  • Update the documentation if you create new features or think the documentation needs to be updated/completed.

  • Commit your changes using a descriptive commit message.

 git commit -a

  • Build your changes locally to ensure all the tests pass:

mvn clean install

  • Push your branch to GitHub:

git push origin issue/<issue-id>-my-fix-branch

  • In GitHub, send a pull request to <gravitee-io/gravitee-api-management>:master.

  • 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 master
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!

Further Information

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

Using a fork of the old gravitee-gateway repository?

If you have a fork of gravitee-gateway and want to update it to get the full API Management monorepo, you can run:

# Add APIM monorepo remote
git remote add upstream https://github.com/gravitee-io/gravitee-api-management
git fetch --all

# Update repo branches, et voilà
git pull upstream BASE_BRANCH

# Update the branch you are working on
# git checkout YOUR_BRANCH
# git rebase BASE_BRANCH

# Push the updated branch
git push origin YOUR_BRANCH