Skip to content

Move parts of the contributing guides to the website #1205

@seisman

Description

@seisman

In PR #1185, we moved the maintainer's guides to the documentation (the doc directory), since the guides are too long and are much easier to read on the documentation website (using the sidebar links).

Similarly, the contributing guides is also too long, with more than 500 lines now, and still increasing (#1119, #1113).

I don't think it's a good idea to move the whole CONTRIBUTING.md file to the documentation. Instead, I think we can only keep basic guides in the repository, but move advanced guides to the documentation.

Basic guides are mainly for first-time contributors or people who are not familiar with github workflows (it means people like me will never read it). IMHO, basic guides can include sections like:

  • What Can I Do?
  • How Can I Talk to You?
  • Reporting a Bug
  • Code Review process
  • General guidelines

Other sections like rules/styles of our documentation and code, instructions to run tests and generate baseline images, are too technical and can be grouped as advanced guides (even people like me need to read it sometimes).

This is just a quick idea, and I'm not sure if it would cause more confusion, but I'd like to hear your thoughts.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions