Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (54 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 2.58 KB

Contributing to react-lazy-loader-js

Thank you for your interest in contributing! We welcome all contributions to improve this project. Please read the following guidelines to help us maintain a high-quality, collaborative codebase.

📋 Table of Contents

Code of Conduct

This project follows the Contributor Covenant. Please be respectful and considerate in all interactions.

How to Contribute

  • Bug Reports: Open an issue describing the problem and steps to reproduce.
  • Feature Requests: Suggest new features or improvements via issues.
  • Pull Requests: Submit code, documentation, or test improvements via PRs.
  • Documentation: Help us improve the README, API docs, or examples.

Reporting Issues

  1. Search existing issues to avoid duplicates.
  2. Provide a clear, descriptive title and detailed information.
  3. Include steps to reproduce, expected behavior, and screenshots if possible.

Submitting Pull Requests

  1. Fork the repository and create your branch from main.
  2. Write clear, concise code and add tests for new features or bug fixes.
  3. Ensure all tests pass (npm test).
  4. Follow the code style and commit message guidelines.
  5. Open a pull request and describe your changes.
  6. Link related issues in your PR description.

Code Style

  • Use Prettier for formatting.
  • Use ESLint for linting.
  • Write clear, self-documenting code and add comments where necessary.
  • Use TypeScript for all source files.
  • Prefer functional components and React hooks.

Commit Messages

  • Use clear, descriptive commit messages.
  • Follow Conventional Commits if possible.
  • Example: fix(retry): handle network abort edge case

Development Setup

git clone https://github.com/your-username/react-lazy-loader-js.git
cd react-lazy-loader-js
npm install
npm run dev

Community Standards

  • Be kind and inclusive.
  • Respect differing viewpoints and experiences.
  • Give and gracefully accept constructive feedback.
  • Help others and ask for help when needed.

Thank you for helping make this project better! 🙏