NotificationsYou must be signed in to change notification settings
Fork191
Star1.2k

adding SPEC_TEMPLATE.md #504#517

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Draft

JHenneberg wants to merge8 commits intofortran-lang:master

base:master

Choose a base branch

fromJHenneberg:feature/He/addSpectemplate

Draft

adding SPEC_TEMPLATE.md #504#517

JHenneberg wants to merge8 commits intofortran-lang:masterfromJHenneberg:feature/He/addSpectemplate

Conversation

Copy link

Contributor

JHenneberg commentedSep 7, 2021•
edited
Loading

This is just the PR resulting from the discussion in#504.

aman-godara reviewed

Sep 7, 2021

View reviewed changes

CONTRIBUTING.md

		@@ -31,6 +31,17 @@ You are welcome to propose changes to the style guide by
		[opening an issue](https://github.com/fortran-lang/stdlib/issues/new/choose) or
		[starting a discussion](https://github.com/fortran-lang/stdlib/discussions/new).

		## Documentation

Copy link

Member

Choose a reason for hiding this comment

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

A new point needs to be added to the 6 bullet points above.

Copy link

Member

awvwgk commentedSep 7, 2021

Do you think it would be better to maintain such template in the wiki? The wiki might already be world-editable, if this is not the case, I can change the permissions there.

Copy link

Member

awvwgk commentedSep 7, 2021

An alternative would be to add the spec template to the pages directory such that it will be visible together with the specs at stdlib.fortran-lang.org.

Copy link

ContributorAuthor

JHenneberg commentedSep 8, 2021

Do you think it would be better to maintain such template in the wiki? The wiki might already be world-editable, if this is not the case, I can change the permissions there.

Personally I am not a fan of the wiki pages, because when you check out the repository you do not have access to them. Also to keep consistency with the other documentsWORKFLOW.md etc I think it is better to have theSPEC_TEMPLATE.md.

This is just the PR resulting from the discussion in#504 , so we should continue the discussion there.

Copy link

Member

milancurcic commentedSep 9, 2021

FWIW I also don't like the WIki pages. Ideally when creating a new spec document, I'd like to just copy the spec template md file from the repo and fill it out.