Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.25 KB

Contributing to Edithor

First off, thank you for considering contributing to Edithor! Your help is essential for making this project better.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub Issues page. Please include:

  • A clear and descriptive title.
  • A detailed description of the bug.
  • Steps to reproduce the issue.
  • Any relevant logs or screenshots.

Suggesting Enhancements

If you have an idea to improve Edithor, I'd love to hear it! Open an issue on our GitHub Issues page and include:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Any relevant examples or mockups.

Contributing Code��

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/mechamobau/edithor.git
    cd edithor
  3. Create a Branch: Create a new branch for your feature or bugfix.

    git checkout -b feature/your-feature-name
  4. Make Changes: Implement your changes.

  5. Commit Changes: Commit your changes with a clear and descriptive commit message.

    git add .
    git commit -m "Add detailed description of your changes"
  6. Push Changes: Push your changes to your fork.

    git push origin feature/your-feature-name
  7. Open a Pull Request: Go to the original repository and open a pull request from your forked repository. Include a detailed description of your changes.

Code Style

Please adhere to the following guidelines to maintain code consistency:

  • Follow Rust's official coding guidelines.
  • Write clear and concise commit messages.
  • Write tests for new features and bug fixes.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Thank You!

Thank you for your interest in contributing to Edithor. Your support is greatly appreciated!