Skip to content

Latest commit

 

History

History
127 lines (81 loc) · 4.44 KB

CONTRIBUTING.md

File metadata and controls

127 lines (81 loc) · 4.44 KB
Raw

Contributing to 50 Days 50 Web Projects

Thank you for considering contributing to the 50 Days 50 Web Projects repository! We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, and code.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Issues
  4. Development Setup
  5. Pull Requests
  6. License

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue and include as much detail as possible. Describe the steps to reproduce the bug, what you expected to happen, and what actually happened.

Suggesting Features

We welcome feature suggestions! Please open an issue with the tag feature and describe your idea in detail. Explain why it would be beneficial and how it should work.

Issues

When opening an issue, please provide:

  • A clear and descriptive title
  • Detailed description of the problem or suggestion
  • Any relevant logs, screenshots, or other information

Development Setup

Follow these steps:

  1. Clone the repository:

    git clone https://github.com/your-username/50_days_50_web_project.git

  2. Navigate to the project directory:

    cd 50_days_50_Web Projects

  3. Install dependencies:

    npm install

  4. Running the Application:

    Once you have installed the dependencies, you can run the application locally using:

    npm run start

    This command will start a development server and open the application in your default web browser on local host .

Pull Requests

We love pull requests! If you have a fix or a new feature, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b my-feature).
  3. Make your changes.
  4. Test your changes.
  5. Commit your changes (git commit -am 'Add new feature').
  6. Push to the branch (git push origin my-feature).
  7. Open a pull request.

Please ensure your pull request adheres to the following guidelines:

  • Describe the purpose of the pull request and the changes made.
  • Reference any related issues or pull requests.
  • Ensure your code follows the project's style guides.
  • Include tests for new features or bug fixes.
  • Update documentation as needed.

Contribution Guidelines

Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines:

Issue Creation

  1. Limit on Issues:
    • Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.

Contribution Levels

  1. Basic Contributions:

    • This project is primarily focused on documentation. Most of the setup has been completed, so contributors will generally need to work on basic code tasks, such as writing tests.
    • For these tasks, issues will be assigned the Easy label.

  2. Acknowledging Hard Work:

    • If a contributor puts in significant effort on a task, the issue will be upgraded to Medium. This is our way of recognizing and appreciating extra effort.

  3. Feature Additions and Component Work:

    • Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work.
    • The more complex and valuable the contribution, the higher the level assigned.

Level Definitions

  • Easy:
    • Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates.
  • Medium:
    • Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements.
  • Hard:
    • Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components.

We look forward to your contributions and appreciate your effort in helping us improve the project!

License

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

Thank you for contributing to 50 Days 50 Web Projects!