Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (52 loc) · 5.04 KB

CONTRIBUTING.md

File metadata and controls

90 lines (52 loc) · 5.04 KB

Welcome to Capture contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on Capture ✨ .

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Before making code contributions, make sure to set up your development environment. Please follow the project's documentation for specific instructions.

Issues

Create a new issue

If you spot a problem with the Capture, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes in a codespace

To access GitHub Codespaces for the repository, follow these steps:

  1. Navigate to your repository on GitHub.

  2. Click on the "Code" button located at the top right of the repository page.

  3. Select "Open with Codespaces" from the dropdown menu.

  4. If you're using Codespaces for the first time, you might need to set up your Codespaces environment. Follow the on-screen instructions to configure your environment.

Once you have configured your environment, you can start making changes to your GitHub repository using Codespaces. Here's what you can do:

  1. Edit Files: Open and edit files in the web-based Codespaces environment. You can use a built-in code editor (VS Code) or other tools.

  2. Run Commands: Execute commands in the integrated terminal to build, test, or run your project.

  3. Version Control: Use Git commands to manage your changes. You can commit, create branches, and push your commits directly to your GitHub repository. Codespaces also integrates with GitHub Pull Requests, allowing you to create and review pull requests from within the environment.

  4. Real-Time Collaboration: If you're working on a collaborative project, multiple users can access and work on the same Codespaces environment simultaneously, making real-time collaboration easy.

Make changes locally

Fork the repository.

  • Using GitHub Desktop:

  • Using the command line:

    • To set up a working development environment, just fork the project git repository.
    • Open your terminal and navigate to the directory where you want to store the project. Then, run the following command to clone the repository: git clone https://github.com/yourusername/capture.git
    • Navigate into the project directory: cd capture
    • Use npm to install the project's dependencies: npm install

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Capture team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.

Your PR is merged!

Congratulations 🎉🎉 The Capture team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the Capture.

Now that you are part of the Capture community, see how else you can contribute to the docs.