Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 2.46 KB

Contributing to KleeneStar

First of all, thank you for considering contributing to WebExpress! We appreciate your support and efforts in improving this project.

If you find a bug or have an idea for an improvement, please open an issue before you start working on it. This allows us to discuss the scope and implementation details and ensure they align with the project goals.

Ways to Contribute

There are various ways you can contribute to WebExpress:

  • Reporting Bugs: If you find a bug, please report it through the Issues page of our repository.
  • Feature Suggestions: If you have an idea for a new feature, also open an issue to discuss it.
  • Contributing Code: For larger contributions and code changes, please follow the steps below.
  • Translation: Help us translate WebExpress into more languages.
  • Writing Documentation: Write or improve documentation to make it clearer and more helpful.
  • Writing Tests: Contribute to creating and improving tests to ensure the quality of the code.

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

  • Bugfixes: If you fix a bug, make sure your code includes a test case that verifies the fix.
  • Features: If you add a new feature, please include documentation and relevant tests.
  • Codestyle: Follow the coding style used in the project. We use Microsoft .NET C# Coding Conventions to enforce consistent coding standards.
  • Tests: Ensure that all existing tests pass and add new tests for your changes if applicable.
  • Documentation: Update the documentation (README, tutorials, etc.) as needed with your changes.

Code Review Process

To ensure that the code is of high quality and meets project standards, every pull request undergoes a code review:

  • Opening the Pull Request: Describe the changes made and their purpose in detail.
  • Assignment of Reviewers: The project team assigns one or more reviewers to the pull request.
  • Review: Reviewers check the code for errors, coding style, tests, and functionality.
  • Feedback and Changes: If necessary, reviewers provide feedback. You are responsible for considering the feedback and making the necessary changes.
  • Approval: Once all reviewers have approved the pull request, it is merged into the main branch.