-
Notifications
You must be signed in to change notification settings - Fork 0
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
MI-111 adding contribution, code of conduct, PR template docs #30
base: main
Are you sure you want to change the base?
MI-111 adding contribution, code of conduct, PR template docs #30
Conversation
|
||
Notes to PR author | ||
|
||
⚠️ Please make sure the changes adhere to the guidelines mentioned here |
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's no link here 🙂
@@ -0,0 +1,13 @@ | |||
Description of the proposed changes |
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.
Minor but some styling would be nice here. Making the titles bold perhaps?
|
||
Make sure the documentation accurately reflects the changes you have made and provides clear instructions or explanations for users. Also, check for any outdated information and remove or update it accordingly. | ||
|
||
## Note for Maintainers |
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.
Some of these need to be re-worded. Constructs doesn't make sense in the context of this repo
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.
Agreed. Probably needs a bit more time spent on making this specific to our repo.
@ryanrixxh I think this is the right direction for Aligent but want to be clear about what we're signing ourselves up for with the code of conduct in particular. |
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. |
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.
Who are 'community leaders' and the 'community' in this context? The FAQ for the covenant doesn't really clarify it. Are we responsible for enforcement? Is github?
|
||
Make sure the documentation accurately reflects the changes you have made and provides clear instructions or explanations for users. Also, check for any outdated information and remove or update it accordingly. | ||
|
||
## Note for Maintainers |
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.
Agreed. Probably needs a bit more time spent on making this specific to our repo.
Adding basic contribution notes :)