General contributing guides

[core-man]

We may have some general contributing guidelines for all the documentation.

What can we contribute to seismo-learn?

• Report typo/bug
• Improve text
• Feature request
• Submit new documentation

#6

How to contribute to seismo-learn

• PR
• Issues
• GitHub Discussions

#6

How to submit PR

PR workflow

• Set up repository
• git workflow
• Submit PR

#15, #17

Edit documentation

• ReST Basics #11
• Code style #10
• sphinx extension #12

Build documentation

• Build documentation #5

Notes about generating new documentation (For mainteners only)

• Notes about sphinx-quickstart #12
• Notes about documentation initialization #14
• Notes about GitHub repository setting #13

#21

References

• https://github.com/GenericMappingTools/pygmt/blob/master/CONTRIBUTING.md
• https://github.com/compgeolab/website/blob/master/CONTRIBUTING.md
• https://github.com/seisman/SAC_Docs_zh/wiki
• https://github.com/gmt-china/GMT_docs/blob/master/CONTRIBUTING.md

[core-man]

I'd like to merge issues #12, #13, #14 into one section "maintainers notes". @seisman
See #12 (comment) and #12 (comment).

[seisman]

Sounds good.