Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2 KB

Contributors.md

File metadata and controls

56 lines (36 loc) · 2 KB

Contributors Guide

Welcome to the repository! We're excited to have you contribute. Please follow the guidelines below to ensure smooth collaboration and project development.

How to Contribute

  1. Raising Issues:

    • If you identify a bug or have an enhancement idea, feel free to raise an issue.
    • Wait for the issue to be reviewed and assigned by the maintainers.

  2. Looking for Issues to Work On:

    • Check out the issues labeled with help wanted. These are open for contributors.
    • Make sure to comment on the issue you'd like to work on before starting, so it can be assigned to you.

  3. Submitting Pull Requests (PRs):

    • After being assigned an issue, fork the repository, make your changes, and submit a PR.
    • Clearly describe the changes you've made in the PR description.

Labels for SWoC Contributors

We use the following labels to help contributors navigate through the repository:

  • good first issue: Beginner-friendly issues to help you get started.
  • BEGINNER: Issues suitable for those new to the topic.
  • INTERMEDIATE: Issues with moderate complexity.
  • ADVANCED: Issues for experienced contributors.
  • help needed: Issues actively looking for contributors.
  • SWOC: Issues specifically marked for SWoC participants.

Discussions and Commenting Guidelines

To maintain a clear history of all issues and discussions:

  1. Under Each Issue:

    • Use the comment section for progress updates, queries, and suggestions related to the issue.
    • Avoid off-topic discussions to keep the issue tracker organized.

  2. Starting a Discussion:

    • Use the Discussions tab for general questions, ideas, or feedback not directly related to an issue.
    • Always be respectful and constructive in your comments.

Need Help?

If you have any queries or need assistance, feel free to ping on #insight-sync under the SWOC Discord server.

Thank you for your interest in contributing to this project. Happy contributing!