Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
130 lines (94 loc) · 6.23 KB

CONTRIBUTING.md

File metadata and controls

130 lines (94 loc) · 6.23 KB

Contributing to Web Wizard

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Web Wizard on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Web Wizard Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to email@example.com.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Web Wizard. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating a bug report, please check the existing issues to see if the problem has already been reported. If it hasn't, you can submit a new issue.

How Do I Submit A Bug Report?

  1. Use a clear and descriptive title for the issue to identify the problem.
  2. Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don’t just say what you did, but explain how you did it.
  3. Provide specific examples to demonstrate the steps. Include links to files or screenshots to help the maintainers understand the issue.
  4. Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  5. Explain which behavior you expected to see instead and why.
  6. Include details about your configuration and environment.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Web Wizard, including completely new features and minor improvements to existing functionality.

Before creating enhancement suggestions, please check the existing issues to see if the enhancement has already been suggested. If it hasn’t, you can submit a new issue.

How Do I Submit An Enhancement Suggestion?

  1. Use a clear and descriptive title for the issue to identify the suggestion.
  2. Provide a step-by-step description of the suggested enhancement in as many details as possible.
  3. Provide specific examples to demonstrate the steps.
  4. Explain why this enhancement would be useful to most Web Wizard users.
  5. Include details about your configuration and environment.

Pull Requests

The process described here has several goals:

  • Maintain Web Wizard’s quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Web Wizard
  • Enable a sustainable system for Web Wizard’s maintainers to review contributions

Your First Pull Request

  1. Fork the repository and create your branch from main.
  2. If you’ve added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  4. Your Pull Request will be reviewed by at least one maintainer.
  5. You may merge the Pull Request in once you have the sign-off of one maintainer, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

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 after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 📝 :memo: when writing docs
    • 🚀 :rocket: when deploying stuff
    • 💄 :lipstick: when adding/updating the UI and style files
    • 🎉 :tada: when adding a new feature
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Code Style

  • Follow the coding conventions used in the project.
  • Write comments to explain why a block of code does something, especially if the reason is not obvious.
  • Write unit tests for new functions and features.

Documentation Style

  • Use Markdown for documentation.
  • Keep the documentation up-to-date with any code changes.
  • Write clear and concise documentation.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests. We encourage contributors to read through these labels to understand the purpose of each.

  • bug: An issue with the code or unexpected behavior.
  • documentation: Documentation or comments in code.
  • enhancement: New feature or request.
  • question: Further information is requested.
  • good first issue: Good for newcomers.
  • help wanted: Extra attention is needed.
  • wontfix: The issue will not be worked on.

Thank you for contributing to Web Wizard!