Commit Graph

12 Commits

Author SHA1 Message Date
Kathi
9a79e1ecf4
Updated Contributing Guide (#6819) 2024-02-24 13:19:18 +07:00
squidfunk
6c1cee0a01
Documentation 2023-12-09 22:27:33 +01:00
Alexander Voss
2bb907d0d9
Added guide for creating Pull Requests (#6429)
* added first draft of instructions for pull requests

* added a diagram to explain process

* added description of the process, moved specific instructions

- split the diagram into two parts to easy comperehension and
  allow people to better follow the process

- added descriptions of the conceptual steps, keeping them
  separate from specific instructions

- moved the specific instructions under a common heading to make
  the ToC more readable

* added explanations

- added link to GitHub docu on forks
- added note on philosophy followed
- improved ToC structure

* tried to finalize process description (see below)

- added airline-style "pay attention to the instructions" tip
- added bit about testing with Material for MkDocs documentation
  and examples from the examples repo
- added note on being respectful in discussion and on how sometimes
  PRs do not get accepted for good reason
- improvements for readability

* moved the "philosophy" bit to the steps

IMHO this is a better place to make this point as the comments are
mainly about what tools are used, which is more relevant to the
instructions, not the 30k ft view process

* added more text to steps guidance, dos and don'ts

- added more text to pretty much every section under 'steps'
- added a section with dos and don'ts
- left some questions for @squidfunk to ponder

* addressing first set of comments

* addressed further comments

In particular:
- removed the bits about linters and
- about dealing with merge conflicts

These may perhaps need attention in the future.

* removing question about PR template
2023-12-09 22:26:42 +01:00
eleanor-arc-boats
1698708b23
Documentation (#6260)
* Update reporting-a-bug.md

fix discussion board link

* space
2023-10-30 21:45:13 +01:00
squidfunk
6e71bb35d7
Documentation 2023-09-21 15:57:54 +02:00
squidfunk
c476842334
Merge branch 'master' into docs/guides 2023-09-21 14:53:33 +02:00
Martin Donath
cd008fdf29
Restructured documentation (#5692) 2023-09-14 19:09:18 +02:00
katharinalisalin
50a1f38c6c Fixed grammar and typos 2023-04-11 14:30:56 +02:00
katharinalisalin
268c5066ba Updated guides 2023-04-04 14:58:40 +02:00
katharinalisalin
58d49fad66 Updated index page 2023-02-09 13:17:30 +01:00
squidfunk
2f883cfff6 Documentation 2023-01-29 22:57:53 +01:00
squidfunk
87fed7ec2e Updated documentation and change request template 2023-01-29 19:14:23 +01:00