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.

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

Add "Pin Component Format" to README.md #81

Open
brentru opened this issue Sep 27, 2022 · 7 comments
Open

Add "Pin Component Format" to README.md #81

brentru opened this issue Sep 27, 2022 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@brentru
Copy link
Member

brentru commented Sep 27, 2022

The README.md has the pin component format as a TODO item.

The format used by pin components is reflected by the pin/schema.json file in this repository.

You may either (simple) link to the schema from within the README file, or (better) explain the schema in the README as a table/visually as you best see fit.

@brentru brentru added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest labels Sep 27, 2022
@VividhPandey003
Copy link
Contributor

Hey, I am a beginner to Open Source and would love to contribute to this issue. Could you please assign this issue to me under Hacktoberfest.⭐️

@brentru
Copy link
Member Author

brentru commented Sep 28, 2022

Hi @VividhPandey003 - as far as I can tell, there is no requirement to assign you to this issue. When you submit a PR, I'll review it, link to this issue and add the HACKTOBERFEST-ACCEPTED label if accepted.

Please see - https://hacktoberfest.com/participation/#contributors

Thanks!

@VividhPandey003
Copy link
Contributor

Okay @brentru got it. Thank you😊

@VividhPandey003
Copy link
Contributor

Hey👋 @brentru, Could you please share an example(docs maybe) if possible regarding the way I should explain the schema.

@brentru
Copy link
Member Author

brentru commented Sep 29, 2022

@VividhPandey003 I'd start by listing each item from properties and their description.

@VividhPandey003
Copy link
Contributor

@brentru that sounds great! Thank you!!😊

@VividhPandey003
Copy link
Contributor

Hey @brentru I've made a Pull Request. Could you please review it and tell me if I need to make any changes.😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants