Skip to content

Latest commit

 

History

History
107 lines (64 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

107 lines (64 loc) · 3.41 KB
Raw
# Contributing to the TODO List App

Thank you for considering contributing to our TODO List App. Your help is greatly appreciated! This guide will help you get started and ensure that your contributions are effective.

## Table of Contents

- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Setting up the Development Environment](#setting-up-the-development-environment)
- [Making Changes](#making-changes)
  - [Coding Guidelines](#coding-guidelines)
  - [Commit Messages](#commit-messages)
  - [Testing](#testing)
- [Submitting Changes](#submitting-changes)
- [Review Process](#review-process)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Getting Started

### Prerequisites

Before you start contributing, ensure you have the following:

- **Git**: Make sure you have Git installed. [Download Git](https://git-scm.com/).

- **GitHub Account**: You'll need a GitHub account to make contributions.

### Setting up the Development Environment

1. **Fork the Repository**: Click the "Fork" button on the top right of the GitHub repository page. This creates a copy of the repository in your GitHub account.

2. **Clone Your Fork**: Clone the forked repository to your local machine:

   ```bash
   git clone https://github.com/your-username/To-Do-List-Application.git

  1. Navigate to the Project Directory:

    cd To-Do-List-Application

  2. Start the Development Server:

    Click on index.html file in your web browser to start using the application.

Now, you have the TODO List App running locally.

Making Changes

Coding Guidelines

  • Follow our coding guidelines to maintain a consistent codebase (link to your coding guidelines document or style guide).

  • Use clear and meaningful variable and function names.

  • Write comments to explain complex sections of code.

Commit Messages

  • Write clear and concise commit messages that describe your changes.

  • Follow the conventional commit format (e.g., "feat: add new feature," "fix: resolve bug"). Learn more about it here.

  • Use the imperative mood (e.g., "fix," "add," "update") in commit messages.

Submitting Changes

  1. Create a New Branch: Create a new branch for your changes:

    git checkout -b feature/my-feature

  2. Make and Commit Changes: Make your changes and commit them with descriptive messages.

  3. Push Changes: Push your changes to your GitHub fork:

    git push origin feature/my-feature

  4. Open a Pull Request: Open a pull request on the main repository with a clear title and description of your changes.

Review Process

  • The maintainers will review your pull request and may request changes or provide feedback.

  • Once your changes are approved, they will be merged into the main branch.

Code of Conduct

Please review and follow our Code of Conduct to ensure a respectful and inclusive environment for everyone.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.


This revised CONTRIBUTING.md file provides more detailed explanations and clear steps for potential contributors. Remember to replace placeholders like `your-username`, `your-branch-name`, and `main-repo` with the actual values relevant to your project.