Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 2.27 KB
Raw

Contributing Guidelines for Code Odyssey Editor

Thank you for your interest in contributing to Code Odyssey Editor! We appreciate all of our contributors, and we are always looking for ways to make our editor better.

This document outlines the guidelines for contributing to Code Odyssey Editor. Please follow these guidelines when submitting code, documentation, or other contributions.

How to Contribute

To contribute to Code Odyssey Editor, please follow these steps:

  1. Fork the Code Odyssey Editor repository.
  2. Create a new branch for your contribution.
  3. Make your changes.
  4. Commit your changes.
  5. Push your branch to your fork.
  6. Create a pull request against the upstream repository.

Code Review

All code contributions will be reviewed before they are merged. The code review process is designed to ensure that the code is high quality, well-tested, and consistent with the coding style of the project.

Documentation

Documentation contributions are also welcome. If you have any suggestions for improving the documentation, please feel free to submit a pull request.

Other Contributions

We also welcome contributions other than code and documentation, such as bug reports, feature requests, and feedback. Please feel free to create an issue on the Code Odyssey Editor repository to submit your contribution.

Coding Style

Code Odyssey Editor uses the following coding style:

  • TypeScript: Prettier
  • HTML: Prettier
  • CSS: Prettier

Please follow these coding styles when making changes to the code.

Testing

All code changes must be accompanied by tests. If you are adding new features, please also add tests for those features.

Licensing

Code Odyssey Editor is licensed under the MIT license. Please make sure that your contributions are licensed under the same license.

Thank you for your contributions!

We appreciate your contributions to Code Odyssey Editor. Your help is making our editor better for everyone.

In addition to the above guidelines, we also encourage contributors to:

  • Be respectful of other contributors and maintainers.
  • Be open to feedback and suggestions.
  • Be willing to work with others to resolve conflicts.
  • Be proud of your work and make it the best it can be.

We look forward to receiving your contributions!