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

Edit CONTRIBUTING.md #31

Open
suhacker1 opened this issue Sep 24, 2020 · 0 comments
Open

Edit CONTRIBUTING.md #31

suhacker1 opened this issue Sep 24, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation needs validation Some validation is required to document the solution

Comments

@suhacker1
Copy link
Collaborator

suhacker1 commented Sep 24, 2020

Is your feature request related to a problem? Please describe.
Instead of a list of bullet points, it would be nice to reorganize the file into sections. It would be helpful if more attention was paid to installation and setup.

Detail any additional context.
Make sure to include that:

  • Right now, all of the tests run on GitHub Actions and therefore must explicitly be defined as not using a GPU
  • All issues under "needs validation" (like this one) should have a comment with an overview of the solution on the issue itself
  • Commands often need poetry to run like poetry run python or poetry run pytest
  • It is best to run Nox before making any commits
  • Explain how to look at the GitHub Projects. The most important issues are at the top
  • Take a look at "help wanted" issues first
  • We prefer tests using Python Hypothesis
  • Link to relevant papers
  • Code should adhere to PyTorch and PyTorch Lightning best practices (See: 1, 2, 3, 4, 5)
  • We're interested in new issues that add new synthesizers, attack configurations, strategies, victim models, and substitute model architectures (or, broadly, whatever improves the scope, efficiency, and effectiveness of PrivacyRaven)
  • Some papers are not reproducible
@suhacker1 suhacker1 added documentation Improvements or additions to documentation needs validation Some validation is required to document the solution labels Sep 24, 2020
@suhacker1 suhacker1 self-assigned this Oct 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs validation Some validation is required to document the solution
Projects
None yet
Development

No branches or pull requests

1 participant