How can I contribute to GradAttack?

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Submitting issues to discuss details of the code
• Submitting issues on Github to report bugs or make feature requests
• Submitting a fix for an eixising issue
• Supporting new models or datasets
• Incorporating new attacks or defenses
• Becoming a maintainer

Slack Channel

For help and realtime updates related to GradAttack, please join the GradAttack Slack!

Getting started

Issues

Create a new issue

If you spot a problem with our library, 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. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

1. Install Git LFS.

2. Fork the repository.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• Using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

• GitHub Codespaces:

  • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.

3. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. Once your changes are ready, 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.

• Make sure you add docstring for your new changes and format your code using yapf.
• Add unit tests for your changes (if necessary), and make sure your code pass all existing tests.
• The title of your pull request should contain a summary of its changes.
• Don't forget to link PR to issue if you are solving one.

Your PR is merged!

Congratulations :tada::tada: The GradAttack team thanks you :sparkles:.

Once your PR is merged, your contributions will be publicly visible in this GitHub repo.

Acknowledgement

Instructions on this page are heavily borrowed from the contributing guide of GitHub Docs.