Become one of the contributors to this jumpstart! We thrive to build a welcoming and open community for anyone who wants to use the jumpstart or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the Code of Conduct.
You can contribute to this project in several ways. Here are some examples:
- Contribute to the jumpstart guide and examples.
- Report and triage errors in the jumpstart guides.
- Scenario requests or submissions
- Help by solving issues raised by others.
All errors/requests/suggestions related to the jumpstart should be submitted here. Issues will be triaged and labels will be used to indicate the type of issue.
We aim to track and document everything related to the jumpstart via the Issues page. The jumpstart is released with no warranties or SLAs and is intended to be supported on a best-effort basis by the Dell GEOS team.
Before submitting a new error/request/suggestion, make sure someone hasn't already gone through the process! Look through the existing issues for similar submissions.
Report a error/request/suggestion by submitting a new issue. Make sure that you provide as much information as possible about the issue, or suggestion.
If this is your first time contributing to an open-source project on GitHub, make sure you read about Creating a pull request.
To increase the chance of having your pull request accepted, make sure your pull request follows these guidelines:
- Title and description matches the implementation.
- Commits within the pull request follow the formatting guidelines.
- If your pull request has conflicts, rebase your branch onto the main branch.
The GEOS team squashes all commits into one when we accept a pull request. The title of the pull request becomes the subject line of the squashed commit message. We still encourage contributors to write informative commit messages, as they becomes a part of the Git commit body.
We use the pull request title when we generate change logs for releases. As such, we strive to make the title as informative as possible.
Make sure that the title for your pull request uses the same format as the subject line in the commit message.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
A pull request must satisfy following for it to be merged:
- A pull request will require maintainer approval.
- Maintainers must perform a review to ensure the changes adhere to guidelines laid out in this document.
- If any commits are made after the PR has been approved, the PR approval will automatically be removed and the above process must happen again.