Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
167 lines (106 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

167 lines (106 loc) · 3.01 KB
Raw

Contributing to 05-HTML5

Thank you for your interest in contributing to this repository.

This repository is designed as a structured educational resource for learning HTML5. Contributions that improve the quality, accuracy, and learning experience are always welcome.

Table of Contents

  • Ways to Contribute
  • Before You Contribute
  • Reporting Issues
  • Suggesting Improvements
  • Pull Requests
  • Coding Standards
  • Documentation Standards
  • Commit Message Guidelines
  • Branch Naming Convention
  • Review Process
  • Contributor Recognition
  • Code of Conduct

Ways to Contribute

You can contribute in many ways, including:

  • Fixing documentation errors
  • Correcting HTML examples
  • Improving explanations
  • Enhancing code readability
  • Adding educational examples
  • Improving accessibility
  • Reporting bugs
  • Suggesting new learning resources

Before You Contribute

Before submitting a contribution:

  • Read the repository documentation.
  • Check existing issues and pull requests.
  • Ensure your contribution aligns with the repository's educational purpose.
  • Test any HTML examples before submitting.

Reporting Issues

If you discover an issue:

  • Clearly describe the problem.
  • Provide steps to reproduce it.
  • Include screenshots if applicable.
  • Suggest a possible solution if you have one.

Suggesting Improvements

Suggestions are welcome for:

  • Documentation improvements
  • Better code examples
  • New HTML5 topics
  • Accessibility enhancements
  • Learning resources
  • Repository organization

Pull Request Guidelines

Before opening a Pull Request:

  • Keep changes focused on a single topic.
  • Ensure examples are tested.
  • Update documentation if required.
  • Follow existing repository formatting.
  • Write clear commit messages.

Coding Standards

Please follow these practices:

  • Use valid HTML5 syntax.
  • Maintain proper indentation.
  • Use meaningful element names.
  • Write clean and readable code.
  • Avoid unnecessary complexity.

Documentation Standards

Documentation should:

  • Be grammatically correct.
  • Use professional language.
  • Include practical examples.
  • Follow the existing Markdown style.
  • Be easy for beginners to understand.

Commit Message Guidelines

Use Conventional Commits whenever possible.

Examples:

docs: update HTML5 forms documentation

feat: add semantic elements example

fix: correct table example

assets: update repository banner

Branch Naming Convention

Examples:

feature/html5-forms

docs/update-readme

fix/table-example

Review Process

Every contribution should:

  • Be reviewed before merging.
  • Maintain repository quality.
  • Preserve educational value.
  • Follow repository standards.

Contributor Recognition

Every meaningful contribution is appreciated.

Contributors help improve this repository for learners around the world.

Code of Conduct

By contributing, you agree to follow the project's Code of Conduct.

Please read the CODE_OF_CONDUCT.md file before contributing.

Thank you for helping improve this repository.