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

[Docs] Add project setup guidelines with commands in contributing.md #30

Closed
Chadha93 opened this issue Nov 17, 2022 · 3 comments · Fixed by #35
Closed

[Docs] Add project setup guidelines with commands in contributing.md #30

Chadha93 opened this issue Nov 17, 2022 · 3 comments · Fixed by #35
Assignees
@HM-8
Labels
area/docs Improvements or additions to documentation framework/jekyll good first issue Good for newcomers help wanted Extra attention is needed language/markdown

Comments

@Chadha93
Copy link
Member

Current State

The contributing.md is missing project setup command instructions.

Desired State

Add project setup guidelines with commands in contributing.md
Refer to the Makefile to get setup commands.

Contributor Guides and Resources
@Chadha93 Chadha93 added area/docs Improvements or additions to documentation framework/jekyll good first issue Good for newcomers help wanted Extra attention is needed language/markdown labels Nov 17, 2022
@HM-8
Copy link
Contributor

HM-8 commented Nov 25, 2022

Hi @Chadha93. Interested in working on this issue. Would love to get some guidance.

@leecalcote
Copy link
Member

@HM-8, after you familiarize with the make targets to build this site, please add a few instructions on how to build the site for other contributors. Here is a reference - https://github.com/layer5io/layer5/blob/master/CONTRIBUTING.md

@HM-8
Copy link
Contributor

HM-8 commented Nov 26, 2022

Okay @leecalcote. I'll get on it. Thanks for the reference.

@HM-8 HM-8 mentioned this issue Nov 26, 2022
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@HM-8 HM-8

Labels
area/docs Improvements or additions to documentation framework/jekyll good first issue Good for newcomers help wanted Extra attention is needed language/markdown
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added project setup guidelines with commands HM-8/play
3 participants
@leecalcote @HM-8 @Chadha93