-
Notifications
You must be signed in to change notification settings - Fork 159
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
Update CONTRIBUTING.md
#1311
base: main
Are you sure you want to change the base?
Update CONTRIBUTING.md
#1311
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.
Looking pretty good from my perspective, but I think we should revert inlining the links.
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 overall, just left a few comments. Regarding the -ing
suggestions, they are just for consistency with other headers, feel free to change it the other way.
CONTRIBUTING.md
Outdated
* [Your Pull Request: From Submission to Merge](#your-pull-request-from-submission-to-merge) | ||
* [Community and Communication](#community-and-communication) |
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.
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.
IMO:
- having
Quick Navigation
part in text is a bit more reader-friendly and beautiful 😄 - "Outline" function is rarely used, from my experience
However, if you insist and think it's a critical point - will revert it back
(Sorry I'm reading some material relating to contributing guides, will do a proper review within the next few business days) |
Sorry for not getting to this, had a lot on my plate. I think we should meet as a team to discuss how best to move forward with this. I think there is a fair bit of information that should ultimately be included in CC @MabezDev |
Now that we have the xtask, I think we should also document some do's and don't of how to use it. For example we should state that all xtask commands should be run from the root of the project, not in a sub project. |
@MabezDev, agree! cc: @jessebraham (as you've had some thoughts and suggestions on this) upd: Also worth mentioning is the update to the HIL tests in case related API was changed |
closes #1225