Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 3.01 KB

Contributing to the PERSCOM Widget

Thank you for your interest in contributing to PERSCOM Widget! We welcome contributions from the community to help improve and grow this project. Please take a moment to read through the following guidelines to ensure a smooth contribution process.

Table of Contents

  1. Getting Started
  2. Making Changes
  3. Submitting Changes
  4. Community and Communication
  5. License

Getting Started

Fork the Repository

To contribute to this project, you'll need to fork the repository to your own GitHub account. Click the "Fork" button on the top-right corner of the repository page.

Clone Your Fork

After forking, clone your forked repository to your local machine:

git clone https://github.com/DeschutesDesignGroupLLC/perscom-widget.git

Set Up the Development Environment

Ensure you have PHP installed on your machine along with any necessary dependencies. Refer to the project's documentation for specific setup instructions.

Making Changes

Branching

Create a new branch for your work, using a descriptive name:

git checkout -b feature/your-feature-name

Coding Guidelines

Please follow the coding style and guidelines defined in the project's documentation. Consistency makes it easier to review and merge your changes.

Testing

Before submitting your changes, make sure to run any relevant tests and ensure that your code does not introduce new issues.

Submitting Changes

Creating a Pull Request

Once your changes are ready, push your branch to your forked repository on GitHub:

git push origin feature/your-feature-name

Then, navigate to the original repository and create a pull request. Provide a clear title and description of your changes.

Pull Request Checklist

Before submitting your pull request, please make sure you have done the following:

  • Followed the coding guidelines.
  • Included relevant tests if applicable.
  • Written clear and concise commit messages.
  • Checked that your code builds and runs without errors.

Community and Communication

Join our community chat to stay connected with other contributors and maintainers. We appreciate your feedback and involvement!

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.