Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explicit instructions for how to submit PRs and how to find good first issues. #26

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 49 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,52 @@ The specifics of development practices for a sub-project or implementation are
detailed in their repositories. For implementations, this includes information
such as the name of the development branch and any additional checks pertaining
to that project. For ITEs, the process of submitting a new proposal is described
in ITE-1.
in ITE-1.

## How to Submit a Pull Request (PR)

1. **Fork the Repository**
- Click the "Fork" button at the top right of the repository page on GitHub.

2. **Clone Your Fork**
- Clone your fork to your local machine:
```sh
git clone https://github.com/your-username/in-toto.git
```

3. **Create a New Branch**
- Create a new branch for your changes:
```sh
git checkout -b my-feature-branch
```

4. **Make Your Changes**
- Make your changes in the code or documentation.

5. **Sign and Commit Your Changes**
- Commit your changes with a descriptive message:
```sh
git add .
git commit -s -m "Description of my changes"
```

6. **Push Your Changes**
- Push your changes to your forked repository:
```sh
git push origin my-feature-branch
```

7. **Create a Pull Request**
- Go to the original repository on GitHub and click "New Pull Request".
- Select your branch and provide a detailed description of your changes.

## Finding Good First Issues

1. **Navigate to Issues**
- Go to the [issues](https://github.com/in-toto/in-toto/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) section of the repository on GitHub.

2. **Filter Issues**
- Use labels like "good first issue" or "help wanted" to find issues suitable for beginners.

3. **Select an Issue**
- Choose an issue that matches your skills and interests, and leave a comment expressing your intent to work on it.