Skip to content

Latest commit

 

History

History
119 lines (81 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

119 lines (81 loc) · 3.27 KB
Raw

Contributing to JS Practice App

Thank you for considering contributing to the JS Practice App! We appreciate your support and are excited to collaborate with you.

Table of Contents

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Getting Started

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/js-practice-app.git

  3. Navigate to the project directory:

    cd js-practice-app

  4. Install the dependencies:

    npm install

  5. Start the development server:

    npm start

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant screenshots or logs.

Suggesting Enhancements

We welcome suggestions to improve the project! To suggest an enhancement, please open an issue on GitHub with the following details:

  • A clear and descriptive title.
  • A detailed description of the suggested enhancement.
  • Why you believe this enhancement would be useful.
  • Any relevant examples or screenshots.

Submitting Pull Requests

  1. Fork the repository and create your branch from main.

    git checkout -b feature/your-feature-name

  2. Make your changes, ensuring that your code adheres to the project's style guides.

  3. Commit your changes with a descriptive commit message.

    git commit -m "Description of your changes"

  4. Push your changes to your forked repository.

    git push origin feature/your-feature-name

  5. Open a pull request on GitHub and provide a detailed description of your changes.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.

JavaScript Style Guide

  • Use const and let instead of var.
  • Prefer arrow functions.
  • Use template literals for string interpolation.
  • Use semicolons.
  • Follow the Airbnb JavaScript Style Guide.

CSS Style Guide

  • Use BEM (Block Element Modifier) naming convention.
  • Prefer flexbox for layout.
  • Use CSS custom properties (variables) for theming.
  • Follow the CSS Style Guide.

License

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