fa
This commit is contained in:
95
CONTRIBUTING.md
Normal file
95
CONTRIBUTING.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# Contributing to STARK Todo List
|
||||
|
||||
First off, thank you for considering contributing to STARK Todo List! 🎉
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
|
||||
|
||||
## How Can I Contribute?
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
Before creating bug reports, please check 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**
|
||||
* **Describe the exact steps to reproduce the problem**
|
||||
* **Provide specific examples to demonstrate the steps**
|
||||
* **Describe the behavior you observed and what behavior you expected**
|
||||
* **Include screenshots if possible**
|
||||
* **Include your environment details** (OS, Node.js version, browser, etc.)
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:
|
||||
|
||||
* **Use a clear and descriptive title**
|
||||
* **Provide a detailed description of the suggested enhancement**
|
||||
* **Explain why this enhancement would be useful**
|
||||
* **List some examples of how this enhancement would be used**
|
||||
|
||||
### Pull Requests
|
||||
|
||||
* Fill in the required template
|
||||
* Follow the TypeScript and React coding style
|
||||
* Include screenshots and animated GIFs in your pull request whenever possible
|
||||
* End all files with a newline
|
||||
* Write meaningful commit messages
|
||||
|
||||
## Development Process
|
||||
|
||||
1. **Fork the repository**
|
||||
2. **Create a branch** from `main` for your feature or fix
|
||||
3. **Make your changes** and test thoroughly
|
||||
4. **Commit your changes** with clear commit messages
|
||||
5. **Push to your fork** and submit a pull request
|
||||
|
||||
### Local Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Start development server
|
||||
pnpm dev
|
||||
|
||||
# Run linter
|
||||
pnpm lint
|
||||
|
||||
# Build for production
|
||||
pnpm build
|
||||
```
|
||||
|
||||
### Coding Standards
|
||||
|
||||
* Use TypeScript for all new code
|
||||
* Follow the existing code style
|
||||
* Use meaningful variable and function names
|
||||
* Add comments for complex logic
|
||||
* Keep functions small and focused
|
||||
* Write self-documenting code
|
||||
|
||||
### Commit Message Guidelines
|
||||
|
||||
We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
|
||||
|
||||
* `feat:` New feature
|
||||
* `fix:` Bug fix
|
||||
* `docs:` Documentation changes
|
||||
* `style:` Code style changes (formatting, etc.)
|
||||
* `refactor:` Code refactoring
|
||||
* `test:` Adding or updating tests
|
||||
* `chore:` Maintenance tasks
|
||||
|
||||
Example:
|
||||
```
|
||||
feat: add dark mode toggle button
|
||||
fix: resolve task deletion bug
|
||||
docs: update installation instructions
|
||||
```
|
||||
|
||||
## Questions?
|
||||
|
||||
Feel free to open an issue with the question label if you have any questions!
|
||||
|
||||
Thank you for contributing! ❤️
|
||||
Reference in New Issue
Block a user