Dariusz Porowski
aefa6e8612
This pull request includes updates to the documentation to reflect changes in the directory structure for the implementation and schema descriptions of resources and data sources. Documentation updates: * [`CONTRIBUTING.md`](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L41-R45): Updated the path for the implementation and schema descriptions of resources and data sources to `./internal/services` instead of `./internal/provider/services`. * [`DEVELOPER.md`](diffhunk://#diff-35ea617bfbf0780bfbc554348314c5b11ba478a4d98fd92d33d45cdd54bf326aL355-R355): Updated the path for the schema information in the provider, resource, and data-source Go files to `./internal/services` instead of `./internal/provider/services`.
4.0 KiB
👥 Contributing Guide
This project welcomes feedback and suggestions only via GitHub Issues. Pull Request (PR) contributions will NOT be accepted at this time. In the future, PRs may be accepted, in which case you will be require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
🔄️ Contribution process (Microsoft FTE only)
To contribute, please follow these steps:
- Fork/clone the project repository on GitHub.
- Create a new branch for your feature or bug fix.
- Make sure the
README.mdand any other relevant documentation are kept up-to-date. - Make your changes and commit them with descriptive commit messages; check Conventional Commits as a suggestion.
- Push to your forked repository or branch.
- Create a new Pull Request from your fork/branch to this project.
- Please ensure that your pull request includes a detailed description of your changes and that your code adheres to the code style guidelines outlined below.
✍️ Types of Contributions
We welcome feedback and suggestions only via GitHub Issues. Pull Request (PR) contributions will NOT be accepted at this time - it may change in the future.
Resources
Creating a new resource can allow terraform to manage new infrastructure/services not currently provided by the provider.
Data Sources
Creating a new data source can allow terraform to reference data about infrastructure and services.
Examples
Examples of real-world use cases are encouraged. Please contribute those types of examples to the Fabric Terraform QuickStarts repo.
☑️ Pull Request Checklist
PRs for new resources or data sources are expected to meeting the following criteria:
- Add a production quality implementation of the resource or data-source in ./internal/services
- Add unit tests and acceptance tests for your contribution in ./internal/provider
- Tests should pass and provide >90% coverage of your contribution
- Add examples for your contribution in ./examples (see Terraform Documentation on examples)
- Add schema descriptions for your resource or data-source in ./internal/services
- and/or ./templates
- Update auto-generated documentation in ./docs. (DO NOT manually edit ./docs or your updates will be overwritten)
- Ensure the PR description clearly describes the feature you're adding and any known limitations
🔰 Code of Conduct
All contributors are expected to adhere to the project name code of conduct. Therefore, please review it before contributing Code of Conduct.
📄 License
By contributing to this project, you agree that your contributions will be licensed under the project license.
Thank you for contributing!