Skip to content

Commit

Permalink
Add How to Contribute section
Browse files Browse the repository at this point in the history
  • Loading branch information
patacca committed Oct 12, 2023
1 parent 47fe9b5 commit 49f1ca6
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,47 @@ reverse-engineering. Tools and associated publications related to diffing are sl
scattered online thus the goal is to reference them here by centralizing information.

You can find the documentation online at [https://diffing.quarkslab.com/](https://diffing.quarkslab.com/)

## How to Contribute

We welcome contributions from the community and appreciate your interest in improving this project.
To get started, please follow these guidelines:

1. **Fork the Repository**: Click the "Fork" button at the top of the repository's page. This will create a copy of the project in your GitHub account.

2. **Clone your Fork**: Use git to clone your fork to your local machine:

```commandline
git clone https://github.com/quarkslab/diffing-portal.git
```

3. **Create a Branch**: Create a new branch for your contribution. Use a clear and descriptive name for your branch.

```commandline
git checkout -b add-new-tool
```

4. **Make Changes**: Make your desired changes or additions to the codebase. Ensure that your changes adhere to our coding standards.

5. **Test**: Test your changes to make sure sphinx compile everything correctly.

6. **Commit Changes**: Commit your changes with a clear and concise commit message:

```commandline
git add .
git commit -m "Add your message here"
```

7. **Push Changes**: Push your changes to your fork on GitHub:

```commandline
git push origin add-new-tool
```

8. **Create a Pull Request (PR)**: In your fork on GitHub, click the "New Pull Request" button. Compare your branch to the main repository's main branch. Provide a descriptive title and detailed information about your changes in the PR description.

9. **Code Review**: The project maintainers will review your PR. Be prepared to make any necessary changes based on their feedback and be patient if not getting an answer immediately.

10. **Merge**: Once your PR is approved, it will be merged into the main repository. Your contribution is now part of the project!

Thank you for your contribution!

0 comments on commit 49f1ca6

Please sign in to comment.