-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add "Effective Communication and Collaboration" chapter #25
Conversation
@BekahHW I have some questions regarding to the subsections on the issue:
TIA! π |
@adiati98 I think all of your comments above are accurate. We don't want to repeat ourselves so your approach to where they should go is the one we should take. |
β¦o-course into feat/add-effective-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.
This is great. I think the end is especially wonderful and does a good job applying the tips. I have some minor things throughout, but I'm happy with how this turned out! Thanks for putting it together.
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.
left a few comments
effective-communication.md
Outdated
|
||
- **Clear guide** | ||
|
||
Whether it's the setup guide on the README, instructions to run and use the project, or Contributing Guidelines, you always want to provide a clear direction for contributors to follow for better collaboration. |
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.
This will probably need to be a separate PR but there are inconsistencies on how we are treating the word README.
The intro file and this file have README without backticks
the issues and prs file uses both README.md
and README
in backticks
There are also inconsistencies between whether to include the .md
for file names like README, CONTRIBUTING and SECURITY.
we will need to open a new issue for that resolve it for all existing files
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.
From this, I also checked our intro to OSS course. There is no consistency too there. We have:
- README
- README file
README.md
- a few README.md (without backticks)
As our courses would be massively used by GitHub users, for terms that related with GitHub, I think it would make sense to follow their style:
README
- README when talking about README in general.
- README file instead of
README.md
when referring to the file.
Here is an example on their docs.
CONTRIBUTING
- contributing / contribution guidelines (all lower case) to refer the guidelines in general.
- CONTRIBUTING file when referring to
CONTRIBUTING.md
.
Here is the example in their docs.
Would love to have yours and @BekahHW thoughts on this.
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.
@adiati98 I think going with the GH style is the right move.
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'll leave this unresolved for our reference. π
effective-communication.md
Outdated
|
||
#### Styling Guide | ||
|
||
You might prefer contributors to add a prefix to issue, pull request titles, and their commit messages. Or you might select particular Markdown rules for your project. Every project has its own convention. So, don't expect your contributors to know what to do when contributing to your project. Consider communicating this in a clear styling guide they must follow. |
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.
After the first sentence would work.
feat: add new feature for user authentication
* minor wording adjustment
@adiati98 all good to merge π |
Description
This PR adds the Effective Communication and Collaboration section.
What type of PR is this? (check all applicable)
Related Tickets & Documents
Closes #11
Mobile & Desktop Screenshots/Recordings
Steps to QA
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?
[optional] What gif best describes this PR or how it makes you feel?