Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 2.07 KB
Raw

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue on our issue tracker. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem or feature request.
  • Steps to reproduce the issue (if applicable).
  • Any relevant screenshots or logs.

Contributing

We welcome contributions to Chromascope! If you have suggestions for new features, bug reports, or would like to contribute code, please open an issue or submit a pull request on our GitHub repository.

Development Setup

  1. Fork the Repository:

    • Create a fork of the Chromascope repository on GitHub.

  2. Clone Your Fork:

    git clone https://github.com/adamcseresznye/chromascope.git
cd chromascope

  3. Create a New Branch:

    git checkout -b feature/your-feature-name

  4. Make Your Changes:

    • Implement your changes, then commit them.

  5. Push to Your Fork:

    git push origin feature/your-feature-name

  6. Submit a Pull Request:

    • Open a pull request on the original repository to merge your changes.

Coding Standards

Please follow our coding standards to ensure consistency in the codebase:

  • Use meaningful variable names and comments.
  • Follow the Chromascope Style Guide.
  • Ensure your code passes all tests before submitting a pull request.

Review and Merge Process

All pull requests will be reviewed by a maintainer. Please ensure that your code:

  • Adheres to our coding standards.
  • Passes all tests.
  • Includes any necessary documentation updates.

Once your pull request is reviewed and approved, it will be merged into the main branch.

Community and Behavioral Expectations

We strive to create a welcoming and inclusive community. Please be respectful and considerate in your interactions. Follow our Code of Conduct to ensure a positive experience for everyone.

Additional Resources