-
Notifications
You must be signed in to change notification settings - Fork 276
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
docs: contributors enhancements #1781
Conversation
Pull Request Test Coverage Report for Build 1745520647
💛 - Coveralls |
I haven't changed the installation part because IMHO, it is straightforward for those willing to contribute to the code, documentation, etc. |
There was a problem hiding this 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.
docs/CONTRIBUTORS.rst
Outdated
|
||
All of the log levels and the corresponding options that could be used for testing are: | ||
tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tests | |
Unit Tests |
There was a problem hiding this comment.
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.
2727afd
to
226a3be
Compare
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. |
No, it's okay. |
There was a problem hiding this 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.
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>
1ae438b
to
c87ff3e
Compare
Pull Request Test Coverage Report for Build 1717934688Warning: 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
💛 - Coveralls |
Pull Request Test Coverage Report for Build 1723423163Warning: 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
💛 - Coveralls |
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