Skip to content

Latest commit

 

History

History
103 lines (69 loc) · 4.34 KB

CONTRIBUTING.md

File metadata and controls

103 lines (69 loc) · 4.34 KB
Raw

Contributing to HTML Learners 2024

Thank you for your interest in contributing to HTML Learners 2024! We are excited to have you join our community. Please follow these guidelines to ensure a smooth and productive collaboration.

Table of Contents

Getting Started

  1. Fork the Repository: Fork this repository to your own GitHub account by clicking the "Fork" button at the top right of this page. This creates a copy of the repository under your GitHub account.

  2. Clone the Forked Repository: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/YOUR_USERNAME/html-learners-2024.git

    Replace YOUR_USERNAME with your GitHub username.

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

    git checkout -b my-new-branch

    Replace my-new-branch with a descriptive name for your branch.

  4. Make Your Changes: Make the necessary changes or add new features to the project.

  5. Commit Your Changes: Commit your changes with a meaningful commit message:

    git add .
git commit -m "Add a new feature"

  6. Push Your Changes: Push your changes to GitHub:

    git push origin my-new-branch

  7. Create a Pull Request: Create a pull request to merge your changes back into the main repository. Go to your forked repository on GitHub and click the "New pull request" button.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please create an issue in the Issues section of the repository. When reporting an issue, please include:

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

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing feature, please open a discussion in the Discussions section. Provide as much detail as possible to help others understand your suggestion.

Submitting Pull Requests

Before submitting a pull request, please ensure that:

  • Your code follows the project's Style Guidelines.
  • You have tested your changes and they work as expected.
  • You have updated the documentation if necessary.

To submit a pull request:

  1. Fork the Repository: Fork this repository to your own GitHub account.

  2. Clone the Forked Repository: Clone the forked repository to your local machine.

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

  4. Make Your Changes: Make the necessary changes or add new features to the project.

  5. Commit Your Changes: Commit your changes with a meaningful commit message.

  6. Push Your Changes: Push your changes to GitHub.

  7. Create a Pull Request: Create a pull request to merge your changes back into the main repository.

Style Guidelines

  • HTML: Use proper indentation (2 spaces per level). Ensure your HTML is valid and well-structured.
  • CSS: Follow the BEM (Block, Element, Modifier) methodology for class naming. Use consistent indentation (2 spaces per level).
  • JavaScript: Write clear and concise code. Use camelCase for variable and function names. Follow the Airbnb JavaScript Style Guide.

Code of Conduct

Please read our Code of Conduct to understand the expected behavior in our community.

Additional Resources

We appreciate your contributions and look forward to collaborating with you.