Improve dev docs #2578
Merged
Improve dev docs #2578
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Remove outdated info on linters * Move DCO info to the top: no-one will find it in the bottom Signed-off-by: Jussi Kukkonen <[email protected]>
Trying to make it clearer that * testing locally is an option * DCO is required Signed-off-by: Jussi Kukkonen <[email protected]>
jku
force-pushed
the
improve-dev-docs
branch
from
5c238c4 to
143a69b
Compare
Pull Request Test Coverage Report for Build 8097156018Details
💛 - Coveralls |
lukpueh
requested changes
Feb 28, 2024
Member
lukpueh
left a comment
lukpueh
left a comment
There was a problem hiding this comment.
Thanks for the initiative, Jussi!
docs/CONTRIBUTING.rst
Outdated
| <https://black.readthedocs.io/>`__ and `isort <https://pycqa.github.io/isort>`__. | ||
| Auto-formatting can be done on the command line: | ||
| The linter in CI/CD will check that new TUF code is formatted with | ||
| `ruff<https://docs.astral.sh/ruff/>`__. Auto-formatting can be done on the |
Member
There was a problem hiding this comment.
I think the whitespace is needed to render correctly. Also, the double-underscore suffix seems to be syntax for "anonymous hyperlink targets", which I don't think makes sense here.
Suggested change
| `ruff<https://docs.astral.sh/ruff/>`__. Auto-formatting can be done on the | |
| `ruff <https://docs.astral.sh/ruff/>`_. Auto-formatting can be done on the |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| Fixes #<ISSUE NUMBER> | ||
|
|
||
|
|
||
| <!-- Please check relevant options (you can remove the ones that do not apply) --> |
Member
There was a problem hiding this comment.
I wonder if we should just remove the items below. They are usually ignored, and even if not, I never found them particularly helpful, neither as reviewer nor as contributor.
Maybe we can include a reminder in the bullet list above, something like:
ensure changes are tested and code docs are updated
Signed-off-by: Jussi Kukkonen <[email protected]>
lukpueh
approved these changes
Feb 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm trying to improve the experience for first time contributors: I think it must be bad since our success rate is probably below 10% for the first version of the first PR...
Other suggestions welcome.