Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (68 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

97 lines (68 loc) · 3.05 KB

Contributing to Homework Tracker Pro

First off, thank you for considering contributing to Homework Tracker Pro! It's people like you that make this project such a great tool for students everywhere.

Code of Conduct

This project and everyone participating in it is governed by our commitment to providing a welcoming and inspiring community for all. Please be respectful and constructive in your interactions.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, 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 you expected to see
  • Include screenshots or animated GIFs if relevant
  • Mention your browser and operating system

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested enhancement
  • Explain why this enhancement would be useful to most users
  • List any similar features in other applications if applicable

Pull Requests

  1. Fork the repository and create your branch from main
  2. Make your changes following our coding standards
  3. Test your changes thoroughly
  4. Update documentation if needed
  5. Write clear commit messages describing your changes
  6. Submit a pull request with a clear description of your changes

Development Setup

  1. Clone the repository:
git clone https://github.com/ossUser-Swift/study-progress-hub.git
cd study-progress-hub
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open your browser to http://localhost:8080

Coding Standards

  • TypeScript: Use TypeScript for all new code
  • Components: Create focused, reusable React components
  • Styling: Use Tailwind CSS with semantic tokens from the design system
  • Formatting: Follow the existing code style and formatting
  • Testing: Test your changes before submitting

Project Structure

src/
├── components/     # Reusable UI components
├── pages/         # Route pages
├── hooks/         # Custom React hooks
├── types/         # TypeScript type definitions
├── lib/           # Utility functions
└── integrations/  # External integrations

Commit Message Guidelines

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests when relevant

Questions?

Feel free to open an issue with your question or reach out to the maintainers.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Homework Tracker Pro! 🎉