Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (53 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 1.82 KB
Raw

Contributing

Thank you for your interest in contributing to this project. Every contribution—whether it's fixing a bug, improving documentation, or adding a new feature—is appreciated.

Getting Started

  1. Fork the repository.

  2. Clone your fork.

    git clone https://github.com/your-username/repository-name.git

  3. Navigate to the project directory.

    cd repository-name

  4. Install dependencies.

    npm install

  5. Start the development server.

    npm run dev

Development Guidelines

  • Write clean, readable, and maintainable code.
  • Follow the existing project structure and coding style.
  • Keep commits focused on a single change.
  • Test your changes before submitting a pull request.
  • Update documentation if your changes affect usage or functionality.

Commit Messages

Use clear and descriptive commit messages.

Examples:

feat: add user profile page
fix: resolve login validation bug
docs: update installation guide
refactor: simplify authentication logic

Pull Request Process

Before submitting a Pull Request, please ensure:

  • Your code builds successfully.
  • You have tested your changes.
  • Documentation has been updated if necessary.
  • Your PR includes a clear description of the changes.

Reporting Issues

If you discover a bug or have a feature request, please open an Issue and include:

  • A clear description of the problem.
  • Steps to reproduce (if applicable).
  • Expected behaviour.
  • Screenshots or logs (if relevant).

Code of Conduct

Please be respectful and maintain a welcoming environment for everyone participating in this project.

Questions

If you have any questions, feel free to open an Issue or start a Discussion.

Thank you for helping improve this project. Your contributions are greatly appreciated.