Skip to main content

Contributing

This document describes the process of contribution to Capact. Any type of contribution is welcome!

Contribution process#

We use GitHub to host code, track issues and feature requests, and accept pull requests.

Report an issue#

To report an issue, follow the steps:

  1. Search open and closed issues on a given GitHub repository to see if your issue is not a duplicate.
  2. Navigate to the "New issue" page on the GitHub repository.
  3. Select an issue template, which is the most accurate for the issue type you report.
  4. Describe the issue clearly according to the selected issue template.

Create a pull request#

To create a new pull request, follow the steps:

  1. Make sure an issue related to the change is reported.

  2. Fork the repository and configure the fork on your local machine. To learn how to do it, read the Prepare the fork section in the Git workflow guide.

  3. Create a branch from the main repository branch. To learn how to do it, follow the Contribute section in the Git workflow guide.

  4. Do the proposed changes.

    Make sure the changes are tested locally.

    NOTE: Remember that large pull requests with multiple files changed are very difficult to review. Discuss the planned changes upfront in the related issue and consider splitting one large pull request into smaller ones.

  5. Commit and push the changes.

    To learn how to do it, follow the Contribute section in the Git workflow guide.

  6. Create a new pull request on the GitHub "Pull requests" page.

    Make sure the option Allow edits from maintainers is selected.

Get your pull request approved#

Once you create a pull request:

  1. Make sure all automated pull request tests pass.

  2. Wait for the repository maintainers to review and approve the pull request. The maintainers are listed in the CODEOWNERS file on a given repository.

    One or more reviewers are assigned automatically. These reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and style. Respond to the review comments and commit changes to the same branch on your fork.

You can contact the reviewers by mentioning GitHub username (@username) in the pull request comments.

Support Channels#

Join the Capact-related discussion on Slack! See the Join us on Slack short guide to learn, how to do it. To report bug or feature, use GitHub issues on a specific repository within the organization.

Code of Conduct#

We adopted a Code of Conduct and we expect project participants to adhere to it. To understand what actions will and will not be tolerated, read the Code of Conduct document.

License#

By contributing to Capact, you agree that your contributions will be licensed under the same license that covers a given repository. You can read the license in the LICENSE file on the root of the repository.