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

adding SPEC_TEMPLATE.md #504 #517

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

JHenneberg
Copy link
Contributor

@JHenneberg JHenneberg commented Sep 7, 2021

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

@@ -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.

@awvwgk
Copy link
Member

awvwgk commented Sep 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.

@awvwgk
Copy link
Member

awvwgk commented Sep 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.

@JHenneberg
Copy link
Contributor Author

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 documents WORKFLOW.md etc I think it is better to have the SPEC_TEMPLATE.md.

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

@milancurcic
Copy link
Member

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.

@awvwgk awvwgk added the documentation Improvements or additions to documentation label Sep 18, 2021
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

Successfully merging this pull request may close these issues.

4 participants