Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 2.8 KB
Raw

Contribution to Const Type Args Framework

Thank you for considering contributing to the Const Type Args framework! We welcome all types of contributions, including bug reports, feature requests, code contributions, documentation improvements, and other contributions.

Please take a moment to read through this document to ensure your contribution is smooth and helpful to the project.

Code of Conduct

Please note that this project is governed by the Code of Conduct. By participating, you agree to abide by its terms.

This project has adopted the .NET Foundation Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

How to Contribute

There are several ways to contribute to the project:

  • Reporting Bugs
  • Requesting Features
  • Submitting Code
  • Improving Documentation
  • Reviewing Pull Requests

We value every contribution, whether it's code or feedback!

Reporting Bugs

If you encounter a bug in the framework, please:

  1. Check Existing Issues: Search the issues to see if the bug has already been reported.

  2. Submit a New Issue: If the bug hasn’t been reported, submit a new issue. Include as much detail as possible, including:

  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Environment details (e.g., .NET version, OS)

Requesting Features

We welcome feature requests! If you have an idea for a feature, please:

  1. Search Existing Discussions: Search the discussions to make sure your feature hasn’t already been requested.

  2. Submit a New Feature Request: If your feature doesn’t exist, open a new discussion. Describe the feature, its use case, and why you think it would benefit the project.

Documentation Improvements

We highly value documentation contributions. Here’s how you can help:

  • Update DocFX documentation site.
  • Improve READMEs. If you find the README lacking in any way, please submit a pull request with your improvements.
  • Fix typos or grammar issues.
  • Contribute to API documentation using XML comments in the code.

License

By contributing to the Const Type Args framework, you agree that your contributions will be licensed under the project's MIT License.

Backward Compatibility

Contributions must not contain breaking changes such as backward incompatible modification of API signatures. The only exception is a new major version of the library. However, it should pass through code review and discussion.