Commit Graph

17 Commits

Author SHA1 Message Date
Florian Müllner
8887301955 docs: List additional docs and API references in README
With this change, all our documentation can now (directly or
indirectly) be accessed from the toplevel README.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
1f22c6681a docs: Expand contribution section in README
Provide a link to the relevant handbook section and some guidance
for submitting a successful merge request, instead of just throwing
two links at the user.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
afc2a7d652 docs: Add section on feature requests
Small and well-defined feature requests can be very useful, but
unfortunately too many are neither small nor well-defined.

Try to improve on that by adding another README section that
explains that changes need design approval, and points to
appropriate places to have broader design discussions,
hopefully without being too off-putting.

While this is unlikely to stop all "bad" feature requests, it
at least gives us something to point to when closing requests.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
5b7ae5de65 docs: Elaborate on issue reporting
We currently just link to the issue tracker without providing
any further guidance.

Improve on that by pointing to the appropriate handbook chapter,
point out extensions as a possible source of issues, and direct
users towards discourse/matrix for support/discussions.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
6e18c00ab8 docs: Elaborate on supported versions
The link to the GNOME schedule was added because of some confusion
of which versions are supported upstream. Briefly outline the
policy of "last two stable + current main", so that the information
can also be deduced from tags etc. without scrolling through the
schedule calendar.

While at it, update the link to the schedule to point to the
future release.gnome.org page.

Death to the wiki!

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
9f5a323e06 docs: Split commit message conventions from README
We currently only have a very brief outline of the commit message
conventions in the README.

Improve on that by splitting out the relevant section into a separate
file that outlines all conventions we use in addition to the general
guidelines in the [handbook].

[handbook]: https://handbook.gnome.org/development/commit-messages.html

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
1fdbd776c4 docs: Mention code of conduct in README
All project interactions are subject to the code of conduct,
so it seems like a good idea to explicitly mention that in
the README.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
50db4e5e1b docs: Remove project wiki reference from README
The wiki is in the process of being retired, so we should stop
linking to it.

Death to the wiki!

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
28df714ded docs: Drop default branch section from README
It's been more than 2 ½ years since we renamed the default branch,
people have probably got the message by now.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:23:24 +01:00
Florian Müllner
77e3ea3451 docs: Use consistent spacing
Sometimes we use a blank line between heading and paragraph,
sometimes we don't. Settle on the former.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
2024-01-27 22:22:11 +01:00
Florian Müllner
7ea0230a86 doc: Update contribution section
We no longer *require* a merge request URL in commit messages, we
ban them (since Marge is kind enough to add them for us).

While at it, add a small section on prefixes (~~stolen from~~
inspired by mutter).

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2572>
2022-12-06 01:49:24 +01:00
Fionn Kelleher
a8f1722a9f readme: Change "GNOME 3" to "GNOME"
Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1944>
2021-08-11 14:41:15 +00:00
Florian Müllner
b58f057713 docs: Add README section for default branch
We are about to change it, so briefly outline how to update local
checkouts.

(Copied from glib)

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1914>
2021-07-18 21:45:46 +00:00
Felix Divo
9ebfd0874c Add a link to supported releases in the README and bug template
Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1246>
2021-03-03 14:47:20 +00:00
Jonas Ådahl
382282b931 README.md: Add contribution section
Include a link to where to create merge requests, and describe the
requirements regarding commit messages which we are about to enforce.

https://gitlab.gnome.org/GNOME/gnome-shell/merge_requests/410
2019-02-13 20:37:39 +01:00
Harry Mallon
614c4480e2 Fix README link 2018-09-01 15:01:46 +01:00
Florian Müllner
02bbf409ea docs: Use Markdown
Markdown produces nicer output where supported, so use that instead
of plain ASCII formatting.
2018-05-23 19:03:01 +02:00