Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project 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.
- Become a contributor
- Submitting issues
- Triage issues
- Your first contribution
- Branching
- Signing your commits
- Pull requests
- Code reviews
- TODOs in the code
You can contribute to this project in several ways. Here are some examples:
- Contribute to the Remote Development Operator documentation and codebase.
- Report and triage bugs.
- Feature requests.
- Write technical documentation and blog posts, for users and contributors.
- Help others by answering questions about this project.
All issues related to the Remote Development Operator should be submitted here. Issues will be triaged and labels will be used to indicate the type of issue. This section outlines the types of issues that can be submitted.
We aim to track and document everything related to the Remote Development Operator via the Issues page. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.
Before submitting a new issue, make sure someone hasn't already reported the problem. Look through the existing issues for similar issues.
Report a bug by submitting a bug report. Make sure that you provide as much information as possible on how to reproduce the bug.
When opening a Bug please include this information to help with debugging:
- Version of relevant software.
- Details of the issue explaining the problem: what, when, where
- The expected outcome that was not met (if any)
- Supporting troubleshooting information. Note: Do not provide private company information that could compromise your company's security.
An Issue must be created before submitting any pull request. Any pull request that is created should be linked to an Issue.
If you have an idea of how to improve this project, submit a feature request.
If you have a question and you can't find the answer in the documentation or issues, the next step is to submit a question.
Triage helps ensure that issues resolve quickly by:
- Ensuring the issue's intent and purpose is conveyed precisely. This is necessary because it can be difficult for an issue to explain how an end user experiences a problem and what actions they took.
- Giving a contributor the information they need before they commit to resolving an issue.
- Lowering the issue count by preventing duplicate issues.
- Streamlining the development process by preventing duplicate discussions.
If you don't have the knowledge or time to code, consider helping with issue triage. The Remote Development Operator community will thank you for saving them time by spending some of yours.
Read more about the ways you can Triage issues.
Unsure where to begin contributing? Start by browsing issues labeled beginner friendly or help wanted.
- Beginner-friendly issues are generally straightforward to complete.
- Help wanted issues are problems we would like the community to help us with regardless of complexity.
When you're ready to contribute, it's time to create a pull request.
We require that developers sign off their commits to certify that they have permission to contribute the code in a pull request. This way of certifying is commonly known as the Developer Certificate of Origin (DCO). We encourage all contributors to read the DCO text before signing a commit and making contributions.
GitHub will prevent a pull request from being merged if there are any unsigned commits.
GPG (GNU Privacy Guard) will be used to sign commits. Follow the instructions here to create a GPG key and configure your GitHub account to use that key.
Make sure you have your user name and e-mail set. This will be required for your signed commit to be properly verified. Check this references:
Once Git and your GitHub account have been properly configured, you can add the -S flag to the git commits:
$ git commit -S -m your commit message
# Creates a signed commitWe use the guidelines for commit messages outlined in How to Write a Git Commit Message
If this is your first time contributing to an open-source project on GitHub, make sure you read about Creating a pull request.
A pull request must always link to at least one GitHub issue. If that is not the case, create a GitHub issue and link it.
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.
- The pull request closes one related issue.
- The pull request contains necessary tests that verify the intended behavior.
- If your pull request has conflicts, rebase your branch onto the main branch.
If the pull request fixes a bug:
- The pull request description must include
Fixes #<issue number>. - To avoid regressions, the pull request should include tests that replicate the fixed bug.
The 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.
GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for support.
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 at least 2 maintainer approvals.
- 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.
Ensure the added code has the required documenation, examples and unit tests.