Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 2.27 KB

Contributing to Bad Words

Thank you for your interest in contributing to Bad Words! We welcome contributions from everyone, and we are grateful for every contribution made to the project. This document provides guidelines for contributing to Bad Words.

How to Contribute

There are many ways to contribute to our project:

  • Reporting Bugs: If you find a bug, please report it by opening a new issue. We appreciate detailed reports that help us understand and replicate the issue.
  • Suggesting Enhancements: Have an idea to make Bad Words better? Open an issue to suggest enhancements. Please provide as much detail and context as possible.
  • Pull Requests: Contributions via pull requests are the best way to propose changes. This could include fixing bugs, adding new features, or updating documentation.

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. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Code of Conduct

Our project adheres to a Code of Conduct that we expect all contributors to follow. Please read Code of Conduct before contributing so that you understand what actions will and will not be tolerated.

Getting Started

  • Fork the repository on GitHub
  • Clone your fork to your local machine
  • Create a new branch for your fix or feature
  • Commit your changes with a clear description of the change
  • Push your branch to your fork
  • Submit a pull request from your fork back to the main repository
  • Await feedback from the project maintainers

Questions?

If you have any questions or need further clarification about contributing, please open an issue, and we will be happy to help.

Thank you for contributing to Bad Words, and we look forward to your contribution!