Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 2.65 KB
Raw

Contributing to Yuna Ai

First off, thank you for considering contributing to Yuna Ai! It's people like you that make Yuna Ai such great stuff.

Code of Conduct

The Yuna Ai Code of Conduct governs this project and everyone participating. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What we are looking for

We love contributions from the community! When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the repository owners before making a change.

Here are some ways you can contribute:

  • by reporting bugs
  • by suggesting enhancements
  • by writing code that can be incorporated into Yuna Ai itself

Getting Started

Before you begin:

  • Ensure you have installed the latest version of Python.
  • Check if your Python environment is set up correctly.
  • Read the README.md for the project setup instructions.

How to report a bug

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Note: If you find a Security Vulnerability, do not create a GitHub issue. Instead, please write to [email protected].

How to suggest a feature or enhancement

If you wish for a feature that doesn't exist in Yuna Ai, you are probably not alone. There are bound to be others out there with similar needs. Open an issue on our GitHub describing the feature you want to see, why you need it, and how it should work.

Your First Contribution

Need help determining where to begin contributing to Yuna Ai? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues that should only require a few lines of code and a test or two.
  • Help wanted issues - issues that should be more involved than beginner issues.

Pull Request Process

  1. Fork the repository and create your branch from main.
  2. Add tests if you've added code that should be tested.
  3. Ensure the test suite passes.
  4. Make sure your code lines.
  5. Issue that pull request!

Code review process

The core team looks at Pull Requests regularly. After feedback has been given, we expect responses within two weeks. After two weeks, we may close the pull request if it shows no activity.

Community

You can chat with the Yuna Ai community on our discord server. This is a great place to ask questions and discover what's new with Yuna Ai.

Thank you

Yuna Ai thrives on its community. Your contributions help us create a better tool for everyone.

Yuna Ai loves you. Keep coding!