Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

92 lines (63 loc) · 3.53 KB

This file provides guidelines on how contributors can get involved in your project.

# Contributing to Low-Latency-AI-Voice-Assistant

Thank you for your interest in contributing to the **Low-Latency-AI-Voice-Assistant**! We welcome contributions to make this project even better. 🚀

## How to Contribute

1. **Fork the repository**  
   Click the "Fork" button at the top-right corner of this page to make a copy of this repository on your GitHub account.

2. **Clone your forked repository**
   ```bash
   git clone https://github.com/your-username/Low-latency-AI-Voice-Assistant.git
   cd Low-latency-AI-Voice-Assistant

  1. Create a new branch for your feature or fix

    git checkout -b your-branch-name

  2. Make your changes

    • Ensure your code follows the project structure and coding conventions.
    • Update the relevant documentation if needed.

  3. Test your changes
    Please make sure that all changes are well-tested and working before opening a pull request (PR).

  4. Commit your changes

    git add .
git commit -m "Brief description of your changes"

  5. Push to your forked repository

    git push origin your-branch-name

  6. Create a pull request
    Go to your fork on GitHub and click the "Compare & Pull Request" button to open a PR.

Code of Conduct

By contributing, you agree to abide by the Code of Conduct to ensure a positive environment for all participants.

Happy coding, and thank you for contributing! 🎉


### 2. `CODE_OF_CONDUCT.md`
This file outlines the expected behavior for contributors.

```markdown
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

---

**Contact Us:**
Please contact us via [maintainer-email@example.com] for any questions or concerns regarding this code of conduct.