noisecanceller / CONTRIBUTING.md
raghu2's picture
fix: enforce login add rate-limit retry logic fix clerk ui and fix binary history
e3362fc
|
Raw
History Blame Contribute Delete
1.49 kB
# Contributing to Stemify AI
First off, thank you for considering contributing to Stemify AI! It's people like you that make open source such a fantastic community.
## How Can I Contribute?
### Reporting Bugs
Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
- Use a clear and descriptive title for the issue.
- Describe the exact steps which reproduce the problem.
- Provide specific examples to demonstrate the steps.
### Suggesting Enhancements
Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please:
- Use a clear and descriptive title.
- Provide a step-by-step description of the suggested enhancement.
- Explain why this enhancement would be useful to most users.
### Pull Requests
1. Fork the Project.
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the Branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request.
## Coding Style
- We use **TypeScript** for all frontend logic. Please ensure your code passes type checks (`npm run build`).
- We use **Tailwind CSS v4** for styling. Do not write custom CSS unless absolutely necessary.
- Ensure all new UI components match the "Pitch Black and Facebook Blue" dark mode aesthetic.
Thank you for contributing!