Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (50 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

65 lines (50 loc) · 1.74 KB

Contributing to Readr

Thanks for our interest in contributing to Readr 🎉. We welcome issue, feature requests, and pull requests to help improve the project.

🐛 Reporting Issues

  • Use the Issues page to report bugs or request features.
  • Include as much detail as possible:
    • Steps to reproduce
    • Expected vs. actual behavior
    • Screenshots (if applicable)

✨ Suggesting Features

  • Open an issue labeled enhancement.
  • Clearly describe the feature and why it would be useful.
  • If possible, suggest how it could be implemented.

🔧 Development Setup

  1. Fork the repository
  2. Clone your fork locally: 
    git clone https://github.com/<your-username>/reading-log-app.git
cd reading-log-app
  3. Open index.html in your browser (no build steps required)

📐 Coding Guidelines

  • Use clear, descriptive commit messages (e.g., feat: add search filter or fix: resolve localStorage bug).
  • Keep code consistent with existing style (vanilla JS, clean HTML, simple CSS).
  • Test your changes before submitting.

🔄 Pull Request Process

  1. Create a feature branch: 
    git checkout -b feature/my-feature
  2. Commit your changes: 
    git commit -m "feat: add my feature"
  3. Push to your branch: 
    git push origin feature/my-feature
  4. Open a Pull Request to main (after reviewing your changes locally)

🤝 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct

📄 License

By contributing, you agree that your contributions will be licensed under the same license as this project.