CONTRIBUTING.md•3.24 kB
# Contributing to TaskFlow MCP
Thank you for considering contributing to TaskFlow MCP! This document provides guidelines and instructions for contributing to this project.
## 🌟 Code of Conduct
By participating in this project, you agree to abide by our Code of Conduct. Please be respectful, inclusive, and considerate in all interactions.
## 🚀 How to Contribute
There are many ways to contribute to TaskFlow MCP:
1. **Reporting Bugs**: If you find a bug, please create an issue with a detailed description.
2. **Suggesting Enhancements**: Have an idea for a new feature? Create an issue to suggest it.
3. **Code Contributions**: Want to fix a bug or add a feature? Submit a pull request.
4. **Documentation**: Help improve the documentation by fixing errors or adding examples.
5. **Testing**: Help test the project and report any issues you find.
## 🐛 Bug Reports
When reporting a bug, please include:
- A clear and descriptive title
- Steps to reproduce the bug
- Expected behavior
- Actual behavior
- Any relevant logs or error messages
- Your environment (OS, Node.js version, etc.)
## 💡 Feature Requests
When suggesting a feature, please include:
- A clear and descriptive title
- A detailed description of the feature
- Why the feature would be useful
- Any relevant examples or use cases
## 🔄 Pull Requests
When submitting a pull request:
1. Fork the repository
2. Create a new branch for your changes
3. Make your changes
4. Run tests to ensure your changes don't break existing functionality
5. Submit a pull request with a clear description of your changes
### Coding Standards
- Follow the existing code style (we use Biome for formatting and linting)
- Write clear, descriptive commit messages
- Add tests for new functionality
- Update documentation as needed
## 🛠️ Development Setup
To set up the project for development:
1. Clone the repository:
```bash
git clone https://github.com/pinkpixel-dev/taskflow-mcp.git
cd taskflow-mcp
```
2. Install dependencies:
```bash
npm install
```
3. Build the project:
```bash
npm run build
```
4. Run in watch mode for development:
```bash
npm run watch
```
## 🧪 Testing
Currently, the project does not have automated tests. If you're adding a new feature or fixing a bug, please manually test your changes to ensure they work as expected.
## 📝 Documentation
If you're adding a new feature or changing existing functionality, please update the documentation accordingly. This includes:
- README.md
- OVERVIEW.md
- Code comments
- Any other relevant documentation
## 🔄 Release Process
The project maintainers will handle releases. If you're a maintainer, follow these steps:
1. Update the version in package.json
2. Update CHANGELOG.md with the changes in the new version
3. Commit the changes
4. Create a new tag with the version number
5. Push the changes and tag
6. Publish to npm:
```bash
npm publish
```
## 📜 License
By contributing to this project, you agree that your contributions will be licensed under the project's MIT license.
## 🙏 Thank You
Thank you for contributing to TaskFlow MCP! Your help is greatly appreciated.
---
Made with ❤️ by Pink Pixel
