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 clear contributor docs to canonical location #749

Open
lukpueh opened this issue May 15, 2024 · 2 comments
Open

Add clear contributor docs to canonical location #749

lukpueh opened this issue May 15, 2024 · 2 comments

Comments

@lukpueh
Copy link
Member

lukpueh commented May 15, 2024

The in-toto Python implementation seems to lack a clear contributor quick start guide. This can be easily fixed:

As a start the whole thing could look very similar to https://theupdateframework.readthedocs.io/en/latest/CONTRIBUTING.html until (excluding) the "Unit Test" section

@lukpueh
Copy link
Member Author

lukpueh commented May 15, 2024

other things to add

  • running the test suite manually, running individual tests, coverage... (this is similar to instructions for theupdateframework above, except that the test suite aggregation script is called runtests.py)
  • auto format with black and isort
    $ black .
    $ isort .
    
  • build docs
    $ cd doc && make html 
    

@DarikshaAnsari
Copy link
Contributor

@lukpueh I have added contributing.md to docs repo. PTAL !

This was referenced May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants