First of all, thank you for considering contributing to Humaan! Your involvement is vital to the success of this open-source project. By collaborating, we can build AI tools that truly benefit humanity.
- Contribute to Humaan - Let's Build AI for Humanity
There are many ways to contribute to Humaan:
- Report Bugs: Identify and report issues to help improve the project.
- Suggest Enhancements: Propose new features or improvements.
- Code Contributions: Fix bugs, implement features, or improve documentation.
- Documentation: Enhance existing documentation or add new sections.
- Community Engagement: Participate in discussions, answer questions, and help other community members.
Before you begin, ensure you have met the following requirements:
- Operating System: Windows, macOS, or Linux
- Node.js: Version 16 or higher
- Rust and Cargo: For building native modules
- Tauri CLI: For building the desktop application
- Git: For version control
WIP
If you find a bug, please open an issue with the following details:
- Summary: A concise description of the bug.
- Steps to Reproduce: Detailed steps to replicate the issue.
- Expected Behavior: What you expected to happen.
- Actual Behavior: What actually happened.
- Screenshots: If applicable, include screenshots to illustrate the problem
- Environment: OS, Node.js version, any other relevant details.
To suggest new features or improvements:
- Use Cases: Explain the problem and how your suggestion solves it.
- Proposal: Describe your suggested enhancement in detail.
- Alternatives: Mention any alternative solutions you've considered.
Before submitting changes:
- Ensure your code follows the project's coding standards.
- Test your changes thoroughly.
- Update documentation if necessary.
- Main Branch (
main
): Contains stable code ready for release. - Development Branch (
develop
): Used for ongoing development. - Feature Branches (
feature/your-feature-name
): For new features or enhancements. - Bugfix Branches (
fix/your-bugfix-name
): For bug fixes.
Create a feature or bugfix branch from develop:
git checkout develop
git pull
git checkout -b feature/your-feature-name
- Language: Follow JavaScript/TypeScript best practices.
- Formatting: Use Prettier for code formatting.
- Linting: Ensure code passes ESLint checks.
Run linting and formatting checks:
npm run lint
npm run format
-
Format: Use the Conventional Commits style.
-
Structure:
<type>(<scope>): <subject>
Examples:
feat(ui): add new theme selector
fix(api): correct data fetching logic
- Push Your Branch
- Open a Pull Request
- Go to your fork on GitHub.
- Click on "Compare & pull request".
- Fill out the pull request template.
- Review and Feedback
- Be responsive to comments and requested changes.
- Discuss any feedback or questions in the pull request.
- Merge
- A maintainer will merge your pull request once it meets all requirements.
- Discord: Join our community server for real-time discussions.
- GitHub Discussions: Participate in community discussions on GitHub.
By contributing, you agree that your contributions will be licensed under the MIT License.
Thank you for helping make Humaan better! Your contributions are what make open-source projects thrive. Together, we're building AI for humanity.