General contributing guides

[core-man]

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

What can we contribute to seismo-learn?

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

6

How to contribute to seismo-learn

• [x] PR
• [x] Issues
• [x] GitHub Discussions

6

How to submit PR

PR workflow

• [x] Set up repository
• [x] git workflow
• [x] Submit PR

15, #17

Edit documentation

• [x] ReST Basics #11
• [x] Code style #10
• [x] sphinx extension #12

Build documentation

• [x] Build documentation #5

Notes about generating new documentation (For mainteners only)

• [x] Notes about sphinx-quickstart #12
• [x] Notes about documentation initialization #14
• [x] 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 https://github.com/seismo-learn/contributing/issues/12#issuecomment-774704463 and https://github.com/seismo-learn/contributing/issues/12#issuecomment-774709522.

[seisman]

Sounds good.