Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.84 KB

Contributing to XtermBlazor

We welcome contributions to the XtermBlazor project! If you would like to contribute, please follow the guidelines below.

Reporting Issues

  • Before creating an issue, please check if it has already been reported.
  • Provide as much information as possible to reproduce the issue.
  • Include error messages, screenshots, and steps to reproduce.

Pull Requests

  • Fork the repository and create your branch from main.
  • If you've added code that should be tested, add tests.
  • Ensure the test suite passes.
  • Make sure your code lints.
  • Update the documentation accordingly.
  • Describe the changes in detail in the pull request description.

Code of Conduct

  • Be respectful and considerate in your interactions with other contributors.
  • Adhere to the project's code of conduct.

Getting Started

  • Read the README.md for project setup instructions.
  • Set up your development environment with the required versions of .NET and Node.js.

Contribution Process

  1. Fork the repository: Click the 'Fork' button at the top right of the page to create your own copy of the repository.
  2. Clone your fork: Use git clone to download your fork to your local machine.
  3. Create a branch: Create a new branch for your changes with a descriptive name.
  4. Make your changes: Work on the issue or feature and commit your changes.
  5. Push to your fork: Push your changes to your fork on GitHub.
  6. Open a pull request: Go to the original XtermBlazor repository and click 'New pull request'. Select your branch and submit.

Style Guide

  • Follow the existing code style.
  • Use meaningful variable and method names.
  • Comment your code where necessary.

License

By contributing to XtermBlazor, you agree that your contributions will be licensed under its MIT License.

Thank you for contributing to XtermBlazor!