|
| 1 | +# Contributing to HTML Learners 2024 |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | +- [Getting Started](#getting-started) |
| 7 | +- [How to Contribute](#how-to-contribute) |
| 8 | + - [Reporting Issues](#reporting-issues) |
| 9 | + - [Suggesting Enhancements](#suggesting-enhancements) |
| 10 | + - [Submitting Pull Requests](#submitting-pull-requests) |
| 11 | +- [Style Guidelines](#style-guidelines) |
| 12 | +- [Code of Conduct](#code-of-conduct) |
| 13 | +- [Additional Resources](#additional-resources) |
| 14 | + |
| 15 | +## Getting Started |
| 16 | + |
| 17 | +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. |
| 18 | + |
| 19 | +2. **Clone the Forked Repository**: Clone the forked repository to your local machine using the following command: |
| 20 | + ```bash |
| 21 | + git clone https://github.com/YOUR_USERNAME/html-learners-2024.git |
| 22 | + ``` |
| 23 | + Replace `YOUR_USERNAME` with your GitHub username. |
| 24 | + |
| 25 | +3. **Create a New Branch**: Create a new branch for your changes: |
| 26 | + ```bash |
| 27 | + git checkout -b my-new-branch |
| 28 | + ``` |
| 29 | + Replace `my-new-branch` with a descriptive name for your branch. |
| 30 | + |
| 31 | +4. **Make Your Changes**: Make the necessary changes or add new features to the project. |
| 32 | + |
| 33 | +5. **Commit Your Changes**: Commit your changes with a meaningful commit message: |
| 34 | + ```bash |
| 35 | + git add . |
| 36 | + git commit -m "Add a new feature" |
| 37 | + ``` |
| 38 | + |
| 39 | +6. **Push Your Changes**: Push your changes to GitHub: |
| 40 | + ```bash |
| 41 | + git push origin my-new-branch |
| 42 | + ``` |
| 43 | + |
| 44 | +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. |
| 45 | + |
| 46 | +## How to Contribute |
| 47 | + |
| 48 | +### Reporting Issues |
| 49 | + |
| 50 | +If you find a bug or have a feature request, please create an issue in the [Issues](https://github.com/HTML-Mastery/html-learners-2024/issues) section of the repository. When reporting an issue, please include: |
| 51 | + |
| 52 | +- A clear and descriptive title. |
| 53 | +- A detailed description of the issue. |
| 54 | +- Steps to reproduce the issue. |
| 55 | +- Any relevant screenshots or code snippets. |
| 56 | + |
| 57 | +### Suggesting Enhancements |
| 58 | + |
| 59 | +If you have an idea for a new feature or an improvement to an existing feature, please open a discussion in the [Discussions](https://github.com/HTML-Mastery/html-learners-2024/discussions) section. Provide as much detail as possible to help others understand your suggestion. |
| 60 | + |
| 61 | +### Submitting Pull Requests |
| 62 | + |
| 63 | +Before submitting a pull request, please ensure that: |
| 64 | + |
| 65 | +- Your code follows the project's [Style Guidelines](#style-guidelines). |
| 66 | +- You have tested your changes and they work as expected. |
| 67 | +- You have updated the documentation if necessary. |
| 68 | +
|
| 69 | +To submit a pull request: |
| 70 | +
|
| 71 | +1. **Fork the Repository**: Fork this repository to your own GitHub account. |
| 72 | +
|
| 73 | +2. **Clone the Forked Repository**: Clone the forked repository to your local machine. |
| 74 | +
|
| 75 | +3. **Create a New Branch**: Create a new branch for your changes. |
| 76 | +
|
| 77 | +4. **Make Your Changes**: Make the necessary changes or add new features to the project. |
| 78 | +
|
| 79 | +5. **Commit Your Changes**: Commit your changes with a meaningful commit message. |
| 80 | +
|
| 81 | +6. **Push Your Changes**: Push your changes to GitHub. |
| 82 | +
|
| 83 | +7. **Create a Pull Request**: Create a pull request to merge your changes back into the main repository. |
| 84 | +
|
| 85 | +## Style Guidelines |
| 86 | +
|
| 87 | +- **HTML**: Use proper indentation (2 spaces per level). Ensure your HTML is valid and well-structured. |
| 88 | +- **CSS**: Follow the BEM (Block, Element, Modifier) methodology for class naming. Use consistent indentation (2 spaces per level). |
| 89 | +- **JavaScript**: Write clear and concise code. Use camelCase for variable and function names. Follow the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript). |
| 90 | +
|
| 91 | +## Code of Conduct |
| 92 | +
|
| 93 | +Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expected behavior in our community. |
| 94 | +
|
| 95 | +## Additional Resources |
| 96 | +
|
| 97 | +- [GitHub Forking Guide](https://guides.github.com/activities/forking/) |
| 98 | +- [GitHub Flow](https://guides.github.com/introduction/flow/) |
| 99 | +- [HTML Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML) |
| 100 | +- [CSS Documentation](https://developer.mozilla.org/en-US/docs/Web/CSS) |
| 101 | +- [JavaScript Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript) |
| 102 | +
|
| 103 | +We appreciate your contributions and look forward to collaborating with you. |
0 commit comments