docs: improve README with detailed setup and contribution guide #74
Conversation
RosanaTSF
commented
Oct 21, 2025
RosanaTSF
commented
- Add comprehensive Getting Started section for macOS and Linux
- Include step-by-step installation instructions
- Add Development section with build and test commands
- Add Contributing section with guidelines for new contributors
- Add examples section with basic usage
- Add tips for beginners
- Improve overall documentation structure
- Add comprehensive Getting Started section for macOS and Linux - Include step-by-step installation instructions - Add Development section with build and test commands - Add Contributing section with guidelines for new contributors - Add examples section with basic usage - Add tips for beginners - Improve overall documentation structure
DescriptionThis PR improves the project's README with comprehensive documentation to help new contributors get started. Changes
Why these changes?As a beginner contributor, I found the original README lacked detailed setup instructions. These improvements will help other newcomers:
Checklist
🎃 Hacktoberfest 2025 contribution |
README.md
Outdated
| terraform version | ||
| ``` | ||
|
|
||
| #### 2. Build and Install the Provider |
There was a problem hiding this comment.
For a user that just wants to use the provider, there is no need to clone and build the repository locally
This can be removed OR marked as optional, in case the user wants to build from source
(Also, your section about development setup already covers this 😄 )
What do you think?
There was a problem hiding this comment.
Thank you for the feedback, @crgisch!
I updated the README to mark the local build step as optional — you're right, it's not needed for regular users.
Clarify optional nature of building the provider locally and provide instructions.
2 participants
