Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 2.47 KB

Certainly! Below is a basic template for a CONTRIBUTING.md file that you can tailor to fit the specifics of your project and contribution process:

Contributing to LangWatch

First off, thank you for considering contributing to LangWatch. It's people like you that make LangWatch such a great tool.

Code of Conduct

At LangWatch, we are committed to fostering an open and welcoming environment. We expect everyone participating in the LangWatch community to offer respect and courtesy to other community members at all times.

  • Respectful Communication: Always communicate professionally. In the case of any conflict, assume good intentions and seek understanding before jumping to conclusions.
  • Consideration: Be considerate of others' perspectives and experiences. Suggestions and criticism are welcome but should be constructive and aimed at improving the project.
  • Inclusivity: Strive for inclusivity and diversity. LangWatch welcomes contributions from everyone who shares our goals.
  • Ethical Conduct: Uphold an exemplary standard of integrity in all your contributions and interactions.
  • Privacy: Never publish others' private information, such as a physical or electronic address, without explicit permission

I don't want to read this whole document!

We understand, here are the basics:

  • For minor fixes: Open a pull request
  • For major changes: Open an issue for discussion before proceeding
  • For suggestions: Open an issue and name it as a feature request

Please note, all contributions should start with an issue first.

How Can I Contribute?

Reporting Bugs and Suggesting Enhancements

Go to the issues tab to report any bug or suggest features.

Pull Requests

The process described here has several goals:

  • Maintain LangWatch's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible LangWatch

Here's how to propose a change:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Additional Notes

Please don't use the issue tracker for support questions. Check whether the Docs offer any help with your problem.

Thank you for reading through this CONTRIBUTING guide. We look forward to your contribution!