Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (48 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

59 lines (48 loc) · 1.59 KB

Contributing to TaskForge

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to TaskForge.
These are mostly guidelines, not rules. Use your best judgment and feel free to propose changes to this document.

How Can I Contribute?

Reporting Bugs

  • Use the GitHub Issues tab.
  • Include steps to reproduce, expected behavior, and screenshots if applicable.

Feature Requests

  • Create an issue tagged with enhancement.
  • Clearly explain the feature and why it would be useful.

Code Contributions

  1. Fork the repository.
  2. Create a feature branch: 
    git checkout -b feature/your-feature-name
  3. Make your changes.
  4. Run tests (if available) to ensure nothing is broken.
  5. Commit with a clear and descriptive message: 
    git commit -m "Add feature: your feature name"
  6. Push to your fork and submit a Pull Request.

Pull Request Guidelines

  • PRs should be small, focused, and atomic.
  • Write clear commit messages.
  • Ensure your code follows ESLint/Prettier (if configured).
  • Add comments for complex code logic.
  • Include tests if your changes involve logic or functionality.

Development Setup

  • Node.js >= 18 recommended.
  • Install dependencies: 
    npm install
  • Start development server: 
    npm run dev

Community Guidelines

  • Be respectful and welcoming.
  • Avoid spamming or self-promotion.
  • Follow the Code of Conduct

Happy coding! 🚀 – The TaskForge Team