chore: add contributing guide

This commit is contained in:
MAZE 2024-05-01 16:25:22 +04:30
parent 81678ea384
commit 5899d1bbbb
2 changed files with 38 additions and 12 deletions

25
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,25 @@
# Contributing Guidelines
Thank you for considering contributing to our project! We welcome your contributions.
## How to Contribute
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/your-feature-name`.
3. Make your changes and commit them: `git commit -m 'feat: add some feature'`.
4. Push to the branch: `git push origin feature/your-feature-name`.
5. Submit a pull request. ⚡
⚠️ **Notice**: Commit messages should follow [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/).
## Report Bugs
To report a bug, please open an issue on GitHub and provide detailed information about the bug, including steps to reproduce it.
## Request Features
To request a new feature, open an issue on GitHub and describe the feature you would like to see added.
## License
By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).

View file

@ -5,6 +5,15 @@
<a href="https://moodist.app">Visit <strong>Moodist</strong></a> | <a href="https://buymeacoffee.com/remvze">Buy Me a Coffee</a>
</div>
## Table of Contents
- [Features](#features)
- [Tools](#tools)
- [Commands](#commands)
- [Contributing](#contributing)
- [Support](#support-moodist)
- [License](#license)
## Features
1. 🎵 Over 75 ambient sounds
@ -20,18 +29,6 @@
1. 🥷 Privacy focused: no data collection
1. 💰 Completely free, open-source, and self-hostable
## Contributing
All contributions, issues, and feature requests are welcome!
1. Fork the project
1. Create your feature branch (`git checkout -b feature/awesome-feature`)
1. Commit your changes (`git commit -m "feat: add awesome feature`)
1. Push to the remote branch (`git push origin feature/awesome-feature`)
1. Open a Pull Request ⚡
⚠️ **Notice**: Commit messages should follow [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/).
## Tools
- ⚡ **TypeScript**: Programming Language
@ -70,6 +67,10 @@ All contributions, issues, and feature requests are welcome!
- `npm run release:patch`: release patch version
- `npm run storybook`: run Storybook
## Contributing
🚧 Please check [CONTRIBUTING.md](CONTRIBUTING.md) file.
## Support Moodist
Give a ⭐ if you liked this project.