Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a CONTRIBUTING.md file #40

Merged
merged 6 commits into from
May 17, 2024
Merged

Add a CONTRIBUTING.md file #40

merged 6 commits into from
May 17, 2024

Conversation

naziba321
Copy link
Contributor

An initial draft of a CONTRIBUTING.md file to this repo for open source documentation.

@naziba321 naziba321 self-assigned this May 3, 2024
@edif2008
Copy link
Member

edif2008 commented May 7, 2024

A couple of things that are missing in the contribution guidelines that I would expect as someone who wants to contribute:

  • How to setup my environment to work on this plugin and run it.
  • Are there any debugging tools that I can make use of? If so, how can I use them?

Check the contributing guidelines for the terraform provider to see what I'm looking for, specifically:

  • Building
  • Installing and using the provider locally
  • Debugging

edif2008
edif2008 reviewed May 17, 2024
View reviewed changes
Copy link
Member

@edif2008 edif2008 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks way better than before. I feel like we're getting closer to completion. 💪

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
edif2008
edif2008 approved these changes May 17, 2024
View reviewed changes
Copy link
Member

@edif2008 edif2008 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussing the feedback, I feel confident that once the comments are addressed, this PR is good to go. 🚀

@naziba321 naziba321 merged commit 32cf0bf into main May 17, 2024
1 check passed
@naziba321 naziba321 deleted the nh/contributing.md branch May 17, 2024 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edif2008 edif2008 edif2008 approved these changes

Assignees

@naziba321 naziba321

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@naziba321 @edif2008