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

Create a style guide #261

Open
fmichonneau opened this issue Dec 18, 2020 · 1 comment
Open

Create a style guide #261

fmichonneau opened this issue Dec 18, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@fmichonneau
Copy link
Contributor

as suggested in #258

having a style guide would be useful to ensure that contributions from different community members are consistent and inclusive.

@fmichonneau fmichonneau added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 18, 2020
@TomKellyGenetics
Copy link
Contributor

TomKellyGenetics commented Jan 18, 2021

To clarify I think some aspects specific to each language will be necessary. If there is a style guide in English and some general points applying to all contributions that would be a helpful starting point though.

We've discussed some consistent style decisions amongst the contributors for Japanese. As the number of contributors increases, it would be good to have somewhere to document these guidelines for new contributors to avoid them feeling they made a mistake during reviews.

Have you considered how you document a style guide? We've been considering using "Read The Docs" (which supports multilingual versions) for other projects as used for this repository:

https://github.com/carpentries-i18n/i18n-handbook
https://carpentries-i18n-handbook.readthedocs.io/en/latest/

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
Projects
None yet
Development

No branches or pull requests

2 participants