-
Notifications
You must be signed in to change notification settings - Fork 4
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] Move CONTRIBUTING to docs folder #40
Conversation
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 good to me! Reviewed everything up to 17b85d9 in 39 seconds
More details
- Looked at
42
lines of code in3
files - Skipped
0
files when reviewing. - Skipped posting
6
drafted comments based on config settings.
1. docs/CONTRIBUTING.md:96
- Draft comment:
Removed a redundant commit rule note. The deleted line repeated similar guidance already provided. - Reason this comment was not posted:
Comment looked like it was already resolved.
2. docs/index.md:17
- Draft comment:
Updated the Contributing Guide link to a relative path. Ensure the relative path matches the moved file location in the docs folder. - Reason this comment was not posted:
Comment did not seem useful.
3. mkdocs.yml:19
- Draft comment:
Updated Contributing Guide nav entry to use a relative path. Verify that this aligns with the updated file location. - Reason this comment was not posted:
Comment did not seem useful.
4. docs/CONTRIBUTING.md:96
- Draft comment:
Removed ambiguous guideline text. Ensure that the commit splitting rules are still clearly communicated if needed. - Reason this comment was not posted:
Confidence changes required:30%
None
5. docs/index.md:17
- Draft comment:
Updated Contributing Guide link to a relative path after moving the file. Verify that the link resolves correctly in the docs. - Reason this comment was not posted:
Confidence changes required:0%
None
6. mkdocs.yml:19
- Draft comment:
Changed the Contributing Guide URL to a relative path. Ensure the MkDocs configuration correctly finds the relocated file. - Reason this comment was not posted:
Confidence changes required:0%
None
Workflow ID: wflow_ypOZZX2Tg5SIbrVk
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet
mode, and more.
17b85d9
to
3a5f6fc
Compare
@ellipsis, please, give me a code review |
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 good to me! Reviewed everything up to 78d3159 in 36 seconds
More details
- Looked at
84
lines of code in5
files - Skipped
0
files when reviewing. - Skipped posting
10
drafted comments based on config settings.
1. .github/PULL_REQUEST_TEMPLATE.md:1
- Draft comment:
Link updated to new CONTRIBUTING.md location in docs folder; ensure consistency across docs. - Reason this comment was not posted:
Confidence changes required:0%
None
2. docs/CONTRIBUTING.md:60
- Draft comment:
Added semicolon at the end of the scripts tag for consistency in punctuation. - Reason this comment was not posted:
Confidence changes required:0%
None
3. docs/index.md:17
- Draft comment:
Updated the Contributing Guide link to a relative path reflecting its new location. - Reason this comment was not posted:
Confidence changes required:0%
None
4. mkdocs.yml:19
- Draft comment:
Navigation link for Contributing Guide updated to relative path; verify it resolves correctly in mkdocs. - Reason this comment was not posted:
Confidence changes required:0%
None
5. .github/PULL_REQUEST_TEMPLATE.md:1
- Draft comment:
The PR template link now correctly points to the new docs location for CONTRIBUTING.md. - Reason this comment was not posted:
Confidence changes required:0%
None
6. docs/CONTRIBUTING.md:60
- Draft comment:
Consider verifying consistent punctuation for bullet items; the semicolon here should match the style used in other lines. - Reason this comment was not posted:
Confidence changes required:33%
None
7. docs/CONTRIBUTING.md:72
- Draft comment:
The removal of the extended example text streamlines the guidelines; ensure that contributors still have clear examples if needed. - Reason this comment was not posted:
Confidence changes required:33%
None
8. docs/changelog.md:11
- Draft comment:
The new changelog entry for moving CONTRIBUTING.md to the docs folder is properly documented. - Reason this comment was not posted:
Confidence changes required:0%
None
9. docs/index.md:17
- Draft comment:
The relative link for the Contributing Guide has been updated correctly; confirm that it resolves properly in the deployed docs. - Reason this comment was not posted:
Confidence changes required:0%
None
10. mkdocs.yml:19
- Draft comment:
The nav entry for the Contributing Guide now uses a relative path consistent with the new file location. - Reason this comment was not posted:
Confidence changes required:0%
None
Workflow ID: wflow_IYKpddU1e2U1POK5
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet
mode, and more.
Important
Move
CONTRIBUTING.md
todocs
folder and update related documentation links.CONTRIBUTING.md
todocs
folder..github/PULL_REQUEST_TEMPLATE.md
to point to new location.docs/index.md
andmkdocs.yml
to point to new location.CONTRIBUTING.md
todocs
folder indocs/changelog.md
.This description was created by
for 78d3159. It will automatically update as commits are pushed.