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.

Sign up for GitHub

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

Jump to bottom

doc: misc enhancements to contributors #1709

Closed
lukpueh opened this issue Dec 6, 2021 · 1 comment · Fixed by #1781
Closed

doc: misc enhancements to contributors #1709

lukpueh opened this issue Dec 6, 2021 · 1 comment · Fixed by #1781
Assignees
@kairoaraujo
Labels
1.0.0 blockers To be addressed before 1.0.0 release backlog Issues to address with priority for current development goals documentation Documentation of the project as well as procedural documentation
Milestone
Sprint 15

Comments

@lukpueh
Copy link
Member

lukpueh commented Dec 6, 2021

Description of issue or feature request:
Here are a few suggestions to enhance our Instructions for Contributors on RTD.

Current behavior:

  • No mention of Secure Systems Lab development guidelines
  • Too extensive (and prominent) section about DCO
  • Too extensive (and outdated/opinionated?) virtualenv description
  • Very extensive description of test logging/verbosity config

Expected behavior:
@lukpueh lukpueh added the documentation Documentation of the project as well as procedural documentation label Dec 6, 2021
@sechkova sechkova added the backlog Issues to address with priority for current development goals label Dec 8, 2021
@lukpueh lukpueh mentioned this issue Dec 15, 2021
Merged
3 tasks
@jku
Copy link
Member

jku commented Dec 16, 2021 •
edited
Loading

  • Shorten description of test logging/verbosity config

#1724 is going to make tox run a reasonable approximation of CI tests so we should suggest that as the way to run tests.

Then after that we can include a short mention on how to run specific tests and the options (-v for logs, --dump for repository dumps when available)

@jku jku added the 1.0.0 blockers To be addressed before 1.0.0 release label Jan 12, 2022
@jku jku added this to the Sprint 15 milestone Jan 12, 2022
kairoaraujo pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 19, 2022
docs: contributors enhancements
2727afd 
This commit simplifies the contributor's doc.
It adds the reference to the Secure Systems Lab Development Guidelines,
gives more evidence to the tox usage, shares information about the tests,
linting, and coverage, and creates a session about submitting
the contributions highlighted by the DCO.

Fixes theupdateframework#1709

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
@kairoaraujo kairoaraujo mentioned this issue Jan 19, 2022
Merged
3 tasks
kairoaraujo pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 20, 2022
docs: contributors enhancements
226a3be 
This commit simplifies the contributor's doc.
It adds the reference to the Secure Systems Lab Development Guidelines,
gives more evidence to the tox usage, shares information about the tests,
linting, and coverage, and creates a session about submitting
the contributions highlighted by the DCO.

Fixes theupdateframework#1709

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
kairoaraujo pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 25, 2022
docs: contributors enhancements
00b773b 
This commit simplifies the contributor's doc.
It adds the reference to the Secure Systems Lab Development Guidelines,
gives more evidence to the tox usage, shares information about the tests,
linting, and coverage, and creates a session about submitting
the contributions highlighted by the DCO.

Fixes theupdateframework#1709

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kairoaraujo kairoaraujo

Labels
1.0.0 blockers To be addressed before 1.0.0 release backlog Issues to address with priority for current development goals documentation Documentation of the project as well as procedural documentation
Projects
None yet
Milestone
Sprint 15
Development

Successfully merging a pull request may close this issue.

docs: contributors enhancements kairoaraujo/python-tuf
4 participants
@jku @kairoaraujo @lukpueh @sechkova