Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (63 loc) · 6.41 KB

CONTRIBUTING.md

File metadata and controls

82 lines (63 loc) · 6.41 KB

🤝 Contributing to Coding United Club Projects

Welcome! We’re thrilled you’re interested in contributing to Coding United Club. Your contributions help our community grow and learn. Whether you’re fixing a bug, proposing a new feature, improving documentation, or helping others, we value your time and curiosity.

Our Pledge & Code of Conduct

Before contributing, please read our Code of Conduct. We expect all members and contributors to adhere to it to ensure our community is welcoming and inclusive for everyone.

🚀 How to Get Started

  1. Join the Conversation & Get Oriented:

  2. Find Something to Work On:

    • Project-Specific Issues: Navigate to the repository of a project you're interested in and check its "Issues" tab.
    • Organization Project Boards: See an overview of tasks on our GitHub Project Boards.
    • Beginner-Friendly Tasks: Look for issues labeled good first issue, help wanted, or documentation. These are great starting points!
    • Have an Idea? If you have a new idea or want to suggest a feature, feel free to open an issue on the relevant repository or discuss it on Discord first.

  3. Set Up Your Workspace & Code:

    • Fork or Branch:
      • Fork the repository if you are not a direct collaborator on the repository or if you want to make significant changes on your own copy first.
      • Create a new branch from the main (or develop) branch if you have write access to the repository. This is the typical workflow for club members working on shared projects.
    • Branch Naming: Follow clear naming conventions (e.g., feature/new-user-signup, fix/navbar-alignment-bug, docs/update-readme-section).
    • Development Environment: Follow any setup instructions in the project-specific README.md or our provided templates (Python Template, Docker Template).

  4. Code, Commit, and Comment:

    • Write clear, readable, and maintainable code.
    • Add helpful comments where necessary to explain complex logic.
    • Keep your commits focused and logical. Use concise, meaningful commit messages.
    • Follow any project-specific guidelines, linters, or style guides mentioned in its README.md.

  5. Open a Pull Request (PR):

    • Push your changes to your fork or branch on GitHub.
    • Open a Pull Request against the main (or develop, confirm the project's standard) branch of the original repository.
    • Provide a clear title and description for your PR:
      • Explain what you’ve changed and why.
      • Link the related issue(s) using keywords like "Closes #123" or "Fixes #456".
    • If your PR is a work in progress, consider creating a Draft Pull Request.
    • Tag relevant reviewers or teammates if you know who should look at it, or ask in the project's communication channel.
    • Not sure how to create a PR? Check out GitHub's guide on creating a pull request.

  6. Review and Merge:

    • Club members or project maintainers will review your PR.
    • Be open to feedback and be prepared to make changes if requested. Discussion is part of the process!
    • Once your PR is approved, it will be merged into the project. Congratulations!

🧠 General Guidelines for Contributors

  • Be Respectful & Kind: Treat everyone with respect. See our Code of Conduct.
  • Communicate Clearly: Ask questions if you're unsure. We’re here to learn together!
  • Collaborate: Respect project timelines and team decisions. Offer and accept constructive feedback.
  • Test Your Work: Always write and test your code (if applicable) before submitting a PR to ensure it works as expected.
  • Keep it Focused: Try to keep your PRs focused on a single issue or feature. Smaller PRs are easier to review.

📜 Types of Contributions We Value

We welcome a wide range of contributions, including but not limited to:

  • Code: Implementing new features, fixing bugs, improving performance.
  • Documentation: Improving README files, writing user guides or tutorials, clarifying setup instructions, fixing typos.
  • Bug Reports: Clearly reporting issues you find in existing projects (please provide steps to reproduce!).
  • Feature Requests: Suggesting new ideas and enhancements.
  • Design: Creating mockups, improving UI/UX, designing graphics or logos.
  • Project Management: Helping manage project boards, organizing tasks, facilitating meetings.
  • Community Support: Answering questions on Discord/InScribe, mentoring others, helping onboard new members.
  • Event Organization: Helping plan and run workshops, talks, or coding sessions.

💡 Questions or Ideas?

If you have questions, ideas, or just want to chat about contributing:

Let’s build something great, together! 🎉