Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

feat: Add "Effective Communication and Collaboration" chapter #25

Merged
merged 31 commits into from
Jan 19, 2024

Conversation

adiati98
Copy link
Member

@adiati98 adiati98 commented Jan 3, 2024

Description

This PR adds the Effective Communication and Collaboration section.

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes #11

Mobile & Desktop Screenshots/Recordings

Steps to QA

Added to documentation?

  • πŸ“œ README.md
  • πŸ““ docs.opensauced.pizza
  • πŸ• dev.to/opensauced
  • πŸ“• storybook
  • πŸ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@adiati98 adiati98 self-assigned this Jan 3, 2024
@adiati98 adiati98 added the documentation Improvements or additions to documentation label Jan 3, 2024
@adiati98
Copy link
Member Author

adiati98 commented Jan 8, 2024

@BekahHW I have some questions regarding to the subsections on the issue:

  1. Providing Constructive Feedback and fostering a positive community culture

    • We touched this a little bit in the Effective Code Reviews subsections of Issues & Pull Requests. Do we still want to talk about it here too?
    • Fostering a positive community culture: would it be better to have this in the "Building and Nurturing a Community" section?
  2. Creating boundaries

    I feel like creating/communicating boundaries is a part of managing expectations. So, we can make it part of "Managing Expectations" section (after Timeline) instead of making a new section. Any thoughts?

    ### Managing Expectations
    The earlier you let contributors know what they can expect from you and what you expect from them, the better. Setting and managing expectations is the key to smooth contributions and project management.
    Here are some ways to help you manage expectations:
    - **Small issues**:
    Just like maintainers, most open source contributors are volunteers. They are not required to, but they help you fix and enhance your project in their spare time. So you can't expect them to work on their issues promptly like a regular employee. With this expectation, you can, for example, break your issues into several small ones to prevent them from taking a long time to work on an issue.
    - **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. Don't expect your contributors to know what to do when contributing to your project. Consider communicating this in a clear guide they must follow.
    - **Support**
    What kind of support can you provide, and where can they reach you? Think of answering questions, pair programming, or office hours, for example, on Discord. To inform this, you can add a section in your README or Contributing Guide.
    - **Timeline**
    You can let your contributors know how long they can expect you to review a pull request or to answer their questions. Inform them if you, for example, won't be available on weekends or after working hours.

TIA! πŸ˜„

@BekahHW
Copy link
Member

BekahHW commented Jan 8, 2024

@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.

@adiati98 adiati98 marked this pull request as ready for review January 10, 2024 16:42
@adiati98 adiati98 requested review from jdwilkin4 and BekahHW January 10, 2024 16:42
Copy link
Member

@BekahHW BekahHW left a 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.

effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jdwilkin4 jdwilkin4 left a 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


- **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.
Copy link
Contributor

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

Copy link
Member Author

@adiati98 adiati98 Jan 12, 2024

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.

Copy link
Member

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.

Copy link
Member Author

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 Show resolved Hide resolved

#### 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.
Copy link
Contributor

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

https://www.conventionalcommits.org/en/v1.0.0/

effective-communication.md Outdated Show resolved Hide resolved
effective-communication.md Outdated Show resolved Hide resolved
@adiati98 adiati98 requested review from BekahHW and jdwilkin4 January 13, 2024 07:45
@adiati98 adiati98 changed the title feat: add Effective Communication and Collaboration section feat: Add "Effective Communication and Collaboration" chapter Jan 17, 2024
@BekahHW
Copy link
Member

BekahHW commented Jan 19, 2024

@adiati98 all good to merge πŸŽ‰

@adiati98 adiati98 merged commit 0bc7ff7 into main Jan 19, 2024
@adiati98 adiati98 deleted the feat/add-effective-communication branch January 19, 2024 19:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Effective Communication and Collaboration section
3 participants