diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9bb4707..f586a76 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,7 +3,8 @@ Thank you for your interest in contributing to our project! Your accepted contributions will be reflected in our repositories and related websites. -Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. +Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectful. +Also, if you are a permanent contributor, read our [DOs and DON'Ts](.github/DONTS.md). ## Getting started diff --git a/.github/DONTS.md b/.github/DONTS.md new file mode 100644 index 0000000..ed690b6 --- /dev/null +++ b/.github/DONTS.md @@ -0,0 +1,25 @@ +# ✅ DOs and ❌ DON'Ts + +These guidelines are key to working effectively as a team. We've learned them through experience, so follow them to avoid common mistakes. + +--- + +## ✅ DOs +- **Align with Goals**: Keep the big picture in mind and break goals into smaller, actionable tasks for clarity and focus. +- **Focus on What Matters**: Work on tasks that directly contribute to our goals. +- **Take Ownership**: Tackle challenges head-on, and if you're stuck, communicate your difficulties with the team. +- **Overlap Work Hours**: Be available between 1–6 PM HKT daily to collaborate effectively. +- **Test Thoroughly**: Ensure your work is reliable and well-tested before marking it complete. +- **Leave Updates**: Share progress frequently through comments or commits, ideally on an hourly basis. +- **Value Time**: Respect others’ time. Work independently but collaborate when needed. Avoid relying on others for things you can handle yourself. +- **Wear Many Hats**: Embrace versatility—code, design, test, write, and explore ideas because we're passionate about building great products. +- **Be Resourceful**: Learn independently by exploring documentation, tutorials, and using tools like AI to find solutions. + +--- + +## ❌ DON'Ts +- **Engage in Low-Value Work**: Avoid tasks that don't meaningfully contribute to our goals. +- **Avoid Responsibility**: Take accountability for your tasks and challenges. +- **Neglect Testing**: Don’t rely on others to test your work for you. +- **Disappear Without Updates**: Keep the team informed—don’t make others chase you for progress. +- **Distract Others**: Avoid unnecessary or irrelevant messages. Share only what’s important and helpful to collaborators. diff --git a/README.md b/README.md index efa6730..534c051 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,8 @@ This is where your contribution journey starts. Make sure to align yourself with: - [Contributing Guidelines](./.github/CONTRIBUTING.md) +- [DOs & DON'T](.github/DONTS.md) - [Sick Leave Policy](./.github/LEAVE_POLICY.md) + +Subscribe to this repository's notifications, as we frequently push fixes and updates. You must be in sync with those updates. +