Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

45 lines (26 loc) · 2.36 KB

Contributing

Thank you for your interest in contributing to PromptPlayground!

We appreciate contributions from everyone, whether it's a bug fix, new feature, or improvement in documentation. This guide aims to give you an overview of how you can contribute.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible and follow the bug report template.

Suggesting Enhancements

Enhancement suggestions are welcome. But please first check if there's a similar suggestion. If not, provide a clear description of the enhancement in as much detail as possible.

Pull Requests

Pull requests are a great way to contribute. Here are a few guidelines you should follow:

  1. Fork the repository and create your branch from main.
  2. If you've added code, add tests to ensure your contribution works as expected.
  3. Ensure your code follows the .NET coding style guidelines.
  4. Ensure all tests pass.
  5. Submit your pull request.

Code Style and Conventions

For this project, we adhere to the .NET coding style guidelines. Here are some key points:

  • Naming Conventions: Use CamelCase for method names, variable names, and properties. Use PascalCase for class names and namespaces.
  • Indentation: Use spaces instead of tabs with a standard indent size of 4.
  • Brace Style: Use the K&R style for braces, where the opening brace goes on the same line as the statement but the closing brace goes on its own line.

For a comprehensive guide, please refer to the .NET coding conventions provided by Microsoft.

Code of Conduct

PromptPlayground adheres to a Code of Conduct adapted from the Contributor Covenant, version 2.0, available at Code of Conduct. By participating, you are expected to uphold this code.

Getting Help

If you have questions or need assistance, feel free to open an issue in our GitHub repository. This is the preferred method of communication for project-related inquiries. You can go to Issues to create a new issue.

Thank you for contributing to PromptPlayground, and we look forward to your contributions!