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

docs: contributors enhancements #1781

Conversation

kairoaraujo
Copy link
Contributor

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 #1709

Signed-off-by: Kairo de Araujo kdearaujo@vmware.com

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@coveralls
Copy link

coveralls commented Jan 19, 2022

Pull Request Test Coverage Report for Build 1745520647

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.692%

Totals Coverage Status
Change from base Build 1745219259: 0.0%
Covered Lines: 4089
Relevant Lines: 4170

💛 - Coveralls

@kairoaraujo
Copy link
Contributor Author

I haven't changed the installation part because IMHO, it is straightforward for those willing to contribute to the code, documentation, etc.

Copy link
Member

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great set of simplifications, @kairoaraujo! I have a few comments inline. Let me know what you think.

@jku also suggested to mention how to run individual tests with additional options (see #1709 (comment)). Could you add a paragraph for that?

Also, since you are already restructuring most of the document. Would you mind converting it to markdown? We use it for many other docs and it feels just easier to edit.


All of the log levels and the corresponding options that could be used for testing are:
tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tests
Unit Tests

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed it, but IMO, Tests would be better once we don't have only unit tests running.

@kairoaraujo kairoaraujo force-pushed the issue#1709/contributors_enhancements branch from 2727afd to 226a3be Compare January 20, 2022 12:46
@kairoaraujo
Copy link
Contributor Author

Also, since you are already restructuring most of the document. Would you mind converting it to markdown? We use it for many other docs and it feels just easier to edit.

I did not convert to Markdown once we would need to add an extension to the sphinx and fix some formatting issues in other Markdown files that triggered a Warning.
It would break our CI docs/readthedocs.org
Should I file a new issue for this migration from RST to MD?

@lukpueh
Copy link
Member

lukpueh commented Jan 20, 2022

Should I file a new issue for this migration from RST to MD?

No, it's okay.

Copy link
Member

@jku jku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a real improvement to me. I noticed one more broken link on RTD, but the changes in this PR seem good.

Kairo de Araujo added 3 commits January 25, 2022 14:01
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>
Fixed some links, RST formatting and made some texts more clear
understanding.

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
Fix the RTD link using the absolute link.

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
@kairoaraujo kairoaraujo force-pushed the issue#1709/contributors_enhancements branch from 1ae438b to c87ff3e Compare January 25, 2022 13:01
@lukpueh lukpueh merged commit e0736d6 into theupdateframework:develop Jan 25, 2022
@coveralls
Copy link

Pull Request Test Coverage Report for Build 1717934688

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.676%

Totals Coverage Status
Change from base Build 1717351178: 0.0%
Covered Lines: 3937
Relevant Lines: 3960

💛 - Coveralls

@coveralls
Copy link

coveralls commented Dec 29, 2024

Pull Request Test Coverage Report for Build 1723423163

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.9%) to 98.609%

Totals Coverage Status
Change from base Build 1722589044: 0.9%
Covered Lines: 3946
Relevant Lines: 3973

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: misc enhancements to contributors
4 participants