diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aa28a20 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to `pan-os-upgrade` + +We welcome contributions to `pan-os-upgrade`! This document provides guidelines and instructions on how to contribute effectively. + +## How to Contribute + +- **Reporting Bugs**: If you find a bug, please open an issue with a clear description and steps to reproduce. +- **Suggesting Enhancements**: For feature requests or suggestions, open an issue with a detailed explanation. +- **Pull Requests**: Before submitting a pull request, ensure it does not duplicate existing work. + +## Pull Request Process + +1. Fork the repository and create your branch from `main`. +2. Make your changes, ensuring they adhere to the project's coding conventions. +3. Write clear, concise commit messages and ensure your code passes any tests. +4. Open a pull request with a comprehensive description of changes. + +## Code of Conduct + +Please adhere to the Code of Conduct to maintain a respectful and collaborative environment. + +## Questions? + +If you have any questions or need further clarification, feel free to open an issue or contact the project maintainers directly. + +Thank you for contributing to `pan-os-upgrade`!