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

Improve contributing guide #73

Merged
merged 25 commits into from
Oct 6, 2020

Conversation

gwarf
Copy link
Member

@gwarf gwarf commented Oct 6, 2020

Improve contributing guide, adding some explicit documentation on using git and GitHub CLI.

@gwarf gwarf added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 6, 2020
@gwarf gwarf requested a review from glarocca as a code owner October 6, 2020 09:09
@gwarf gwarf self-assigned this Oct 6, 2020
@enolfc
Copy link
Contributor

enolfc commented Oct 6, 2020

Should we move this to the actual page instead of linking?

Copy link
Contributor

@enolfc enolfc left a comment

Choose a reason for hiding this comment

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

Thanks @gwarf ! Some minor comments.

I feel the style of docs should be highlighted before all the PR details (there is only the comment on valid MD and 80 lines)

content/en/about/contributing/_index.md Outdated Show resolved Hide resolved
content/en/about/contributing/_index.md Outdated Show resolved Hide resolved
content/en/about/contributing/_index.md Outdated Show resolved Hide resolved
content/en/about/contributing/_index.md Outdated Show resolved Hide resolved
content/en/about/contributing/_index.md Outdated Show resolved Hide resolved
content/en/about/contributing/_index.md Show resolved Hide resolved
content/en/about/contributing/_index.md Outdated Show resolved Hide resolved
@gwarf
Copy link
Member Author

gwarf commented Oct 6, 2020

I've disabled prettier for now, in fact it's more to be used on users' computers to re-write the content properly than to be used as a linter as the --check output is not very convenient/meaningful: it can only show that files have not went through prettier.
This should still be enough to be used to check code, but will only be enabled when most/all content will have been properly updated.

See https://prettier.io/docs/en/comparison.html

@gwarf gwarf requested a review from enolfc October 6, 2020 13:27
@gwarf
Copy link
Member Author

gwarf commented Oct 6, 2020

I've also started to add a place with some markdown tips, would be good to have us add things that make sense and that we easily forgot. I was lazy and put it in the style page...

@gwarf gwarf closed this Oct 6, 2020
@gwarf gwarf reopened this Oct 6, 2020
@gwarf gwarf requested a review from enolfc October 6, 2020 14:06
Copy link
Contributor

@enolfc enolfc left a comment

Choose a reason for hiding this comment

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

Go!

@gwarf gwarf merged commit 872de76 into EGI-Federation:master Oct 6, 2020
@gwarf gwarf added the hacktoberfest-accepted Accepted for hacktoberfest label Oct 12, 2020
@gwarf gwarf deleted the improve_contributing_guide branch November 19, 2020 10:58
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 enhancement New feature or request hacktoberfest-accepted Accepted for hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Properly document, check and enforce line length Provide a markdown styleguide
2 participants