Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

87 lines (65 loc) · 3.65 KB

Contributing to SyncUp

Thank you for considering contributing to SyncUp, a real-time messaging application and Slack clone! Contributions are what make open-source projects thrive, and we’re excited to see how you can help improve SyncUp. By contributing to this project, you agree to adhere to the following guidelines.

Table of Contents

Getting Started

If you’re new to GitHub or open-source contribution, check out these helpful guides:

To contribute to this project:

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine.
  3. Create a new branch for each feature or bug fix.
  4. Push your changes to your fork and submit a pull request.

How to Contribute

Reporting Issues

If you find any bugs, inconsistencies, or have questions:

  1. Check existing issues to avoid duplicates.
  2. Open a new issue with a descriptive title and details.
  3. When reporting a bug, include steps to reproduce the issue, expected behavior, and screenshots if possible.

Submitting Pull Requests

If you have an improvement or a bug fix:

  1. Make sure your pull request (PR) is focused. Avoid multiple features/fixes in a single PR.
  2. Follow the coding standards outlined below.
  3. Test your changes thoroughly to ensure nothing is broken.
  4. Document your changes where necessary, especially if adding new features.

To submit a PR:

  • Open your PR against the main branch.
  • Provide a clear and concise title and description for your changes.
  • Link any related issues in the PR description.

Feature Requests

We welcome ideas for new features! If you have a feature request:

  1. Check existing feature requests to see if someone has already suggested it.
  2. If it’s unique, open a new issue and label it as a feature request.
  3. Provide a detailed description of the proposed feature, use cases, and potential benefits.

Setting Up Your Development Environment

To set up SyncUp locally, follow the instructions in the README for installing dependencies and configuring environment variables. If you run into any setup issues, feel free to open an issue or reach out.

Coding Standards

To maintain consistency:

  • Use JavaScript ES6+ for all code.
  • Follow standard linting practices (prettier, ESLint).
  • Keep functions and methods small and single-purpose.
  • Write clear and descriptive comments where necessary.

Community

Stay connected with other contributors:

  • Join discussions in issues and pull requests.
  • Help other contributors by reviewing pull requests or offering insights on issues.
  • Be respectful and patient with others.

License

By contributing to SyncUp, you agree that your contributions will be licensed under the MIT License.

Contact

If you have any questions, feel free to reach out:

Thank you for helping make SyncUp better! We’re excited to collaborate with you.