Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 2.06 KB
Raw

Contributing to vATC Suite

Welcome! We appreciate your interest in contributing to vATC Suite. This guide will provide you with the necessary information to help you contribute effectively.

Getting Started

Before contributing, please ensure you have the latest version of the code by cloning the repository:

gh repo clone VMGWARE/vATCSuite

You will also need PHP 8.1 or later installed on your system. You can download PHP from the PHP website.

Contributing Guidelines

Here are some general guidelines to follow when contributing to vATC Suite:

  1. Fork the repository: Create a personal fork of the repository by clicking the "Fork" button on Github.
  2. Create a branch: Create a new branch on your forked repository for the feature or bug fix you plan to contribute.
  3. Commit changes: Make your changes and commit them to your branch. Use descriptive commit messages and include any necessary documentation or tests.
  4. Push changes: Push your changes to your forked repository.
  5. Create a pull request: Submit a pull request from your branch to the main repository, describing the changes you've made.

Code Style Guidelines

Please follow the existing code style guidelines used in the project when contributing:

  • Use 4 spaces for indentation
  • Use descriptive variable and function names
  • Avoid hardcoding values when possible
  • Follow the PSR-12 coding standard
  • Write comments to explain non-obvious code logic

Bug Reports

If you find a bug, please open an issue in the Github issue tracker. Please include a clear and concise description of the issue, including steps to reproduce it.

Feature Requests

If you have a feature request, please open an issue in the Github issue tracker. Please include a clear and concise description of the feature you would like to see, as well as any relevant details.

Conclusion

Thank you for considering contributing to vATC Suite. Your contributions are greatly appreciated and will help make the tool even better for its users.