Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 2.6 KB

Contributing to MensoAI

We welcome contributions from the community! Whether you're fixing bugs, adding new features, improving documentation, or spreading the word, your help is valuable.

Here are some ways you can contribute:

1. Report Bugs

If you encounter a bug or unexpected behavior, please open an issue on GitHub and provide the following information:

  • Steps to reproduce the bug: Clear and concise steps to reproduce the issue.
  • Expected behavior: What you expected to happen.
  • Actual behavior: What actually happened.
  • Screenshots or error messages: If applicable.
  • System information: Your operating system, Python version, and relevant hardware details.

2. Suggest New Features

Have an idea for a cool new feature or improvement? Open an issue on GitHub and describe your suggestion in detail. Include:

  • The problem you're trying to solve: What user need will this feature address?
  • Your proposed solution: How would the feature work?
  • Potential benefits: How would this feature improve MensoAI?
  • Any relevant examples or resources: If applicable.

3. Improve Documentation

Clear and comprehensive documentation is essential. You can contribute by:

  • Fixing typos or errors: Correcting any mistakes in the documentation.
  • Improving clarity: Making the documentation easier to understand and follow.
  • Adding new content: Creating new documentation for features or components.

4. Write Code

If you're a developer, you can contribute code by:

  • Fixing bugs: Resolving issues reported in the issue tracker.
  • Implementing new features: Adding new functionality to MensoAI.
  • Creating new components: Developing new components to extend MensoAI's capabilities.

Before submitting code, please:

  • Fork the repository: Create your own copy of the repository on GitHub.
  • Create a new branch: Create a new branch for your changes.
  • Follow coding conventions: Adhere to the project's coding style and conventions.
  • Write tests: Include tests for your code to ensure its correctness.
  • Submit a pull request: Submit your changes as a pull request for review.

5. Spread the Word

Help us spread the word about MensoAI by:

  • Starring the repository: Show your support and help others discover the project.
  • Sharing on social media: Tell your friends and followers about MensoAI.
  • Writing blog posts or articles: Share your experiences and insights about using or contributing to MensoAI.

We appreciate all contributions, big or small!

Thank you for being a part of the MensoAI community!