Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 2.37 KB
Raw

Contribution Guidelines

Thank you for considering contributing to Curious Connect, an open-source microservice-based video conferencing application. Your contributions help improve the project for everyone!

Onboarding

To join our community and start contributing, please follow these steps:

  1. Join our community on Curious Developers Community - GSSoC.
  2. Familiarize yourself with our project's goals and ongoing discussions.
  3. Reach out to admins for any onboarding assistance or questions.

Bug Reporting

If you encounter a bug, please follow these guidelines:

  1. Search existing issues on GitHub Issues to avoid duplicates by filtering issues by the label Bug.
  2. If the bug hasn't been reported, open a new issue by choosing the Bug Report template and fill in all the required information in that template:
    • Description
    • Screenshots
    • Steps to reproduce
    • Expected behavior
    • Environment or Browser

Suggesting Enhancements

We welcome your ideas for enhancing Curious Connect. Before suggesting an enhancement, please:

  1. Check existing issues to see if your idea has been discussed by filtering issues by the label enhancement.
  2. If it's a new idea, create a new enhancement issue by choosing the feature_request template and provide:
    • Description of the enhancement
    • Justification for the enhancement
    • Potential implementation approach

Working on Issues

To work on an open issue, follow these steps:

  1. Before making a PR, check the assigned issue carefully and know to which feature branch you should make a PR.
  2. Fork the repository and clone your forked repository to your local machine: git clone https://github.com/your-username/Curious-Connect.git
  3. Navigate to the cloned repository: cd Curious-Connect
  4. Checkout to the feature branch to which you are going to make PR: git checkout feature-branch-name
  5. Create your own branch from the feature branch: git checkout -b your-branch-name
  6. Make your changes and test thoroughly.
  7. Add, commit, and push your changes to your forked repository.
  8. Create a pull request to the feature branch branch of the original repository.
  9. Clearly describe your changes and why you think they should be merged.
  10. Be willing to make any requested changes or improvements.