Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 4.49 KB

CONTRIBUTING.md

File metadata and controls

93 lines (60 loc) · 4.49 KB

Contributing to Azure Policy Governance and Compliance Automation

Thank you for considering contributing to this open-source project! Your contributions help improve and enhance the capabilities of our Azure Policy Governance and Compliance Automation project. Whether you are a developer, Azure expert, or simply enthusiastic about cloud governance, we welcome your contributions.

Before you start contributing, please take a moment to read this document to understand how to get involved and contribute effectively.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to Email.

How Can I Contribute?

There are several ways to contribute to this project:

Reporting Bugs

If you encounter any issues, bugs, or unexpected behavior in the project, please open an issue on GitHub. When reporting bugs, please include as much detail as possible, such as the steps to reproduce the issue and your environment's specifications.

Suggesting Enhancements

If you have ideas for enhancements or new features, feel free to open an issue to discuss your suggestions. We appreciate your feedback and will consider all constructive ideas.

Code Contributions

If you would like to contribute code to the project:

  1. Fork the project repository.
  2. Create a new branch for your changes: git checkout -b feature/your-feature-name.
  3. Make your changes and ensure they follow our style guidelines.
  4. Test your changes thoroughly.
  5. Update the documentation if necessary.
  6. Submit a pull request with a clear description of your changes and their purpose.

Getting Started

To get started with development, you'll need to set up your local development environment. Refer to the Getting Started guide for detailed instructions on how to set up and configure your development environment.

Development Workflow

Our development workflow includes the following steps:

  1. Fork the repository.
  2. Create a feature branch.
  3. Make code changes.
  4. Test your changes.
  5. Update documentation.
  6. Commit your changes.
  7. Push your changes to your fork.
  8. Create a pull request.

Style Guidelines

Please follow the style guidelines provided in the project's documentation to maintain consistency in code formatting and structure.

Testing

All code contributions should be accompanied by appropriate tests. Ensure that your changes do not break existing functionality, and write tests to cover new features or bug fixes.

Documentation

If you make changes that affect the project's documentation, be sure to update the documentation accordingly. Documentation is an essential part of the project and helps users understand how to use the software effectively.

Pull Request Process

When submitting a pull request, please adhere to the following process:

  1. Ensure your code and documentation changes are well-tested.
  2. Write a clear and descriptive pull request title.
  3. Provide a detailed description of your changes in the pull request body.
  4. Reference any related issues or discussions in the description.
  5. Be prepared to address any feedback or questions during the review process.

Maintainers

This project is maintained by Your Name and Maintainer 2. If you have any questions or need assistance, feel free to reach out to them.

We appreciate your contributions to the Azure Policy Governance and Compliance Automation project and look forward to collaborating with you!