Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.55 KB

Contributing to ZTodo

Thank you for your interest in contributing to ZTodo! This document outlines the process for contributing to the project.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a new branch for your feature or bugfix
  4. Make your changes
  5. Test your changes thoroughly
  6. Commit your changes with clear, descriptive commit messages
  7. Push your branch to your fork on GitHub
  8. Open a Pull Request against the main repository

Development Guidelines

Code Style

  • Follow consistent indentation (2 spaces)
  • Use meaningful variable and function names
  • Add comments for complex logic

Testing

  • Test your changes manually before submitting a PR
  • Ensure your changes don't break existing functionality

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb in the present tense (e.g., "Add feature" not "Added feature")
  • Reference issue numbers if applicable

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the documentation if you're changing functionality
  3. Your PR should be reviewed by at least one maintainer
  4. Once approved, a maintainer will merge your PR

Feature Requests and Bug Reports

Please use GitHub Issues to report bugs or request features.

  • For bugs, describe the issue clearly and provide steps to reproduce
  • For feature requests, describe the feature and why it would be valuable

License

By contributing to ZTodo, you agree that your contributions will be licensed under the project's Apache License 2.0.