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

added focus-areas template #280

Merged
merged 3 commits into from
Jun 22, 2021
Merged

Conversation

ritik-malik
Copy link
Member

Hi,

As discussed in #276, I added the templates for focus-areas READMEs,
Would be happy to do the suggested changes.

Signed-off-by: ritik-malik ritik18406@iiitd.ac.in

Signed-off-by: ritik-malik <ritik18406@iiitd.ac.in>

The following template describes the structure of READMEs for focus-areas in each WG repositories:

---
Copy link
Member

Choose a reason for hiding this comment

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

Instead of lines, use
```

That will make the template look more like a template and can be copied more easily.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Signed-off-by: ritik-malik <ritik18406@iiitd.ac.in>
@GeorgLink
Copy link
Member

Thanks for making the change. It looks great.

One more suggestion: change the headings "Part 1" and "Part 2" to something more descriptive.

@ritik-malik
Copy link
Member Author

hmm how about we use their entire name as written in line 4 and 5 -

## Template for WG/focus-areas/README.md instead of ## Part 1

and

## Template for WG/focus-areas/<focus-area-name>/README.md instead of ## Part 2

@GeorgLink
Copy link
Member

Good idea

Signed-off-by: ritik-malik <ritik18406@iiitd.ac.in>
@GeorgLink
Copy link
Member

Thank you !

@GeorgLink GeorgLink merged commit 6484254 into chaoss:master Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants