Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.98 KB

Contributing to CentoSync

We're excited that you're interested in contributing to CentoSync! This document outlines the process for contributing to this project and how to get started.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description of the suggested enhancement.
  • Provide any relevant examples or mockups if applicable.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Make sure your code is formatted.
  5. Issue that pull request!

Development Setup

To set up CentoSync for development:

  1. Fork and clone the repo
  2. Run npm install to install dependencies
  3. Run npm run dev to start the development server

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • good first issue - Good for newcomers.

Questions?

If you have any questions, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!).

Thank you for contributing to CentoSync!