Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 2.31 KB

How to Contribute to Watchtower

We're excited that you're interested in contributing to the Watchtower project! This document provides guidelines for contributions. Whether you're fixing bugs, proposing new features, or improving documentation, your help is welcome.

Getting Started

  1. Fork the Repository

    • Start by forking the Watchtower repository to your GitHub account.

  2. Clone Your Fork

    • Clone your fork to your local machine:
      git clone https://github.com/codeforpakistan/watchtower.git
    • Navigate into the cloned directory:
      cd watchtower

  3. Create a Branch

    • Create a new branch for your changes:
      git checkout -b feature/your-new-feature-name

Making Changes

  1. Follow Code Style

    • Please keep your coding style consistent with the existing project. Use clear, readable variable names and include comments where necessary.

  2. Write Meaningful Commit Messages

    • Commit messages should clearly explain what the commit does. Start with a brief summary of changes (max 50 characters), followed by a blank line and a more detailed explanation if needed.

  3. Update Documentation

    • If you add or change functionality, update the README.md or other relevant documentation.

  4. Test Your Changes

    • Ensure your changes do not break existing functionality. Add tests if you're adding new features.

Submitting a Pull Request

  1. Push Your Changes

    • Push your changes to your fork:
      git push origin feature/your-new-feature-name

  2. Open a Pull Request

    • Navigate to the original "Watchtower" repository you forked.
    • Press the "Pull Request" button and choose your branch.
    • Title the pull request clearly and provide a description of the changes.
    • Link any relevant issues.

  3. Review Process

    • Once submitted, the project maintainers will review your pull request. Be open to feedback and requests for any changes if necessary.

Code of Conduct

  • Respect the time and effort of maintainers by making clear and concise contributions.
  • Maintain a positive and inclusive environment. We do not tolerate harassment of any form.
  • Contributions should not include any offensive or harmful material.

License

By contributing to Watchtower, you agree that your contributions will be licensed under its MIT License.