Thank you for considering contributing to Mind's Mom! We appreciate your interest in helping us improve and enhance our mental health support app. Your contributions are valuable in making a positive impact on the lives of our users.
Before you start contributing, please take a moment to read and understand these guidelines.
- Code of Conduct
- How Can I Contribute?
- Development Setup
- Pull Request Process
- Style Guide
- Community
- License
By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others when contributing.
If you encounter any bugs or issues while using Mind's Mom, please open a new issue on our GitHub repository. When reporting bugs, please provide detailed information about the problem, including steps to reproduce it and the platform/environment you're using.
We welcome suggestions for improving the app! You can submit enhancement ideas by opening a new issue on GitHub. Describe your proposed enhancement in detail, including its purpose and potential benefits.
If you're interested in contributing code to Mind's Mom, follow these steps:
- Fork the repository.
- Create a new branch for your work:
git checkout -b feature/your-feature-name. - Make your changes and commit them.
- Push your changes to your fork.
- Submit a pull request to the
mainbranch of the main repository.
Improvements to our documentation are always welcome. You can enhance our documentation by editing the Markdown files in the docs directory. After making changes, submit a pull request.
If you're fluent in multiple languages, you can help translate the app's content. Check for existing translation projects or start a new one.
Reviewing pull requests and testing new features and bug fixes is a crucial contribution. Your feedback helps maintain the quality of the app. You can participate by reviewing pull requests, providing feedback, and testing changes.
To set up a development environment for Mind's Mom, please refer to our Development Setup Guide.
Before submitting a pull request, ensure the following:
- Your code follows our style guide.
- You have written tests for your changes where applicable.
- Your changes do not break existing functionality.
- Your pull request includes a clear and concise description of the changes.
Follow our Style Guide for code formatting and best practices.
Join our community on Discord to connect with other contributors and users. We appreciate your involvement and look forward to collaborating with you!
By contributing to Mind's Mom, you agree that your contributions will be licensed under the MIT License.