Skip to content

Latest commit

 

History

History
153 lines (109 loc) · 6.05 KB

CONTRIBUTING.md

File metadata and controls

153 lines (109 loc) · 6.05 KB

Contributing

Welcome to the Brook Code Theme for Zed project!. We appreciate your interest in contributing to our open-source project. This document outlines the guidelines and best practices for contributing to the project effectively. By following these guidelines, you can help us maintain a collaborative and efficient development process.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Contributing
  4. Coding Guidelines
  5. Communication
  6. License

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it carefully before contributing. By participating, you are expected to uphold the Code of Conduct.

Getting Started

Prerequisites

Before you start contributing, make sure you have the following prerequisites installed:

  • Latest version of Zed
  • Latest version of Rust
  • Official documenntation for Zed

Setting Up the Project

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine. 
    git clone https://github.com/brook-code-theme/zed-theme.git
  3. Navigate to the project directory then open it, install the depenndencies. 
    zed zed-theme
bun install

Running the Project

You can run, start debug and tested the theme in your local environment. To do this, you should follow thhese steps:

  1. Open the project in Zed.
  2. Ensure you're running in the latest version of Zed.
  3. Start debug the code and see the result for your theme changes locally by install theme in your Zed manually.
  4. Now you can start test the project.
  5. To ensure code clean you can run the following command: 
    bun run format

For more information, and learn how to use this project please refer to

Submitting Changes

After all of your changes are made, you can submit your changes for review and merge. To do this, you should doing pull request for your code.

Contributing

We welcome various forms of contributions, including bug reports, feature requests, and pull requests.

Bug Reports

If you encounter a bug or unexpected behavior in the project, please follow these steps:

  1. Ensure the bug hasn't been reported already by searching the issue tracker.
  2. If the bug hasn't been reported, open a new issue and provide a clear title and description of the problem.
  3. Include steps to reproduce the bug and provide any relevant code snippets or error messages.
  4. Be responsive to any follow-up questions or requests for clarification.

Feature Requests

If you have a suggestion for a new feature or enhancement, please follow these steps:

  1. Check the issue tracker to see if the feature has been requested before.
  2. If it hasn't been requested, open a new issue.
  3. Clearly describe the feature you'd like to see, including its purpose and any specific requirements or dependencies.
  4. Engage in any discussions or clarifications related to the feature request.

Pull Requests

We appreciate pull requests from the community. To contribute your changes via a pull request, please follow these steps:

  1. Make sure your forked repository is up to date with the main branch.

    git fetch origin
git checkout main
git pull origin main

  2. Create a new branch for your changes.

    git checkout -b your-feature-name

  3. Implement your changes, adhering to the coding guidelines mentioned below.

  4. Commit your changes with clear and descriptive commit messages.

    git commit -m "🌸 feature: your feature description"

  5. Push your branch to your forked repository.

    git push

  6. Open a new pull request from your branch to the main branch of the main repository.

  7. Provide a concise description of your changes in the pull request, along with any relevant information.

  8. Be responsive to any feedback or review comments related to your pull request.

Coding Guidelines

Code Style

  • Follow the existing code style and conventions used in the project.
  • Use consistent indentation and naming conventions.
  • Write clear and self-explanatory code that is easy to read and understand.
  • Comment your code where necessary to provide additional context or explain complex logic.

Documentation

  • Maintain high-quality documentation to help others understand and use the project effectively.
  • Document new features, APIs, and important changes in the project.
  • Write clear and concise documentation using markdown format.
  • Update existing documentation if changes affect its accuracy or completeness.

Communication

We encourage open and respectful communication within the community. You can reach out to us through the following channels:

License

By contributing to the Event Planner project, you agree that your contributions will be licensed under the project's LICENSE.