Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

60 lines (37 loc) · 2.29 KB

Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone, whether it's a bug report, feature suggestion, or code contribution.

Code of Conduct

Please review and adhere to our Code of Conduct to foster an inclusive and respectful community.

Ways to Contribute

There are several ways you can contribute to this project:

  1. Reporting Bugs: If you encounter any issues or unexpected behavior, please open an issue and provide detailed information about the problem.

  2. Feature Requests: Have an idea for a new feature or enhancement? Open an issue and share your proposal. We welcome feedback and suggestions!

  3. Code Contributions: Found a bug you'd like to fix or have an improvement to contribute? We'd love to review your pull request! Please follow the contribution process outlined below.

Contribution Process

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/Zeddxx/moobie.git
    
  3. Create a new branch for your contribution:

    git checkout -b feature/your-feature
    
  4. Make your changes and ensure that the code follows our coding standards.

  5. Test your changes thoroughly to ensure they don't introduce any regressions.

  6. Commit your changes with a descriptive commit message:

    git commit -am 'Add: Description of your changes'
    
  7. Push your changes to your forked repository:

    git push origin feature/your-feature
    
  8. Finally, submit a Pull Request (PR) against the main branch of the original repository. Be sure to provide a clear description of your changes in the PR.

Code Standards

  • Follow the existing code style and conventions.
  • Write clear, concise, and meaningful commit messages.
  • Ensure your code is well-documented, especially for new features or changes.

Getting Help

If you have any questions or need further assistance, feel free to reach out via email or open an issue.

Thank you for your interest in contributing to our project! 🎉