Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

75 lines (44 loc) · 2.65 KB
Raw

Contributing to Crystal

Thank you for your interest in contributing to Crystal! Contributions from all community members are welcome, and this document is intended to help guide those contributions.

How to Contribute

Contributions to Crystal can come in various forms, including:

  • Code submissions via pull requests
  • Bug reports and feature requests through issues
  • Documentation improvements
  • General feedback on the project

Getting Started

  1. Fork the Repository

    • Begin by forking the repository. This allows for safe experimentation and changes without impacting the original project.

  2. Clone Your Fork

    • Once forked, clone the repository to your local machine to start making changes.

  3. Set Up Your Development Environment

    • Ensure all necessary development tools are installed, including Swift and any other dependencies.

  4. Create a Branch

    • It is recommended to create a new branch in the fork for each set of changes.

Making Changes

  • Commit messages should be clear and concise, accurately describing the implemented changes.
  • All code must adhere to the existing style and standards.
  • Thorough testing of changes is encouraged before submitting a pull request.

Submitting Pull Requests

  1. Pull Request Process

    • Changes should be pushed to the forked repository.
    • Submit a pull request to the main Crystal repository with a detailed description of the changes and any relevant issue numbers.

  2. Review Process

    • Submitted pull requests will undergo a review process.
    • Engagement in the review process may be necessary to address any feedback or required changes.

  3. Approval and Merge

    • Approved changes will be merged into the main repository.

Reporting Bugs

  • The issue tracker is intended for bug reports.
  • Detailed descriptions of the bug, including steps to reproduce and the expected outcome, are very helpful.

Requesting Features

  • Feature requests should be submitted through the issue tracker.
  • The proposed feature’s functionality, necessity, and potential implementation should be detailed.

Community and Conduct

  • All interactions with the project should adhere to the Code of Conduct.
  • Efforts are made to maintain a welcoming and inclusive environment for all participants.

Recognition

  • Significant contributions that result in considerable improvements or solutions to substantial issues will be recognized within the project documentation.

Help and Questions

  • Questions regarding contributing can be directed to the discussion forums or issue tracker.

Thank you for considering contributing to Crystal, and looking forward to seeing your contributions!