Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

50 lines (38 loc) · 2.79 KB
Raw

Contributing to gemfire-examples

We welcome contributions from the community and first want to thank you for taking the time to contribute!

Please familiarize yourself with the Code of Conduct before contributing.

Before you start working with gemfire-examples, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.

Ways to contribute

We welcome many types of contributions and not all of them need a Pull request. Contributions may include:

  • New examples
  • Improvements for clarity
  • Answering questions and giving feedback

Getting started

See the readme on instructions for executing the examples in this project.

Contribution Flow

The gneral workflow to contribute your changes:

  • Make a fork of the repository within your GitHub account
  • Create a topic branch in your fork from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
  • Push your changes to the topic branch in your fork
  • Create a pull request containing that commit
  • Our automated tests will run and leave test results on your PR
  • Address any test issues or feedback left by our contributors

We follow the GitHub workflow. You can find details on the GitHub flow documentation.

Pull Request Checklist

Before submitting your pull request, we advise you to use the following:

  1. Check if your code changes will pass both code linting checks and unit tests.
  2. Ensure your commit messages are descriptive. We follow the conventions on How to Write a Git Commit Message. Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.
  3. Check the commits and commits messages and ensure they are free from typos.

Reporting Bugs and Creating Issues

In order to make sure your report is actionable please make sure to include

  • Relevant version numbers (GemFire, JDK, relevant extensions)
  • Clear reproduction steps
  • How does the observed behavior differ from what you expected?

Ask for Help

The best way to reach us with a question when contributing is to create a GitHub issue.