https://github.com/quarkslab/diffing-portal
Static site for diffing portal
https://github.com/quarkslab/diffing-portal
Last synced: 5 months ago
JSON representation
Static site for diffing portal
- Host: GitHub
- URL: https://github.com/quarkslab/diffing-portal
- Owner: quarkslab
- Created: 2023-03-08T17:04:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-14T09:48:09.000Z (about 1 year ago)
- Last Synced: 2025-05-14T10:52:22.559Z (about 1 year ago)
- Language: Jupyter Notebook
- Size: 8.06 MB
- Stars: 4
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Diffing Portal
This documentation aims to provide various resources on binary diffing which is handy for
reverse-engineering. Tools and associated publications related to diffing are slightly
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!