Commit Graph

50 Commits

Author SHA1 Message Date
Jelle Raaijmakers
d78590fe0d Docs: Use the term 'amend' instead of 'squash' in CONTRIBUTING.md
Hopefully this makes it more clear what the intended action is. For a
lot of people "squashing" means combining multiple commits into one,
which is a common practice when merging to a branch.
2023-08-09 07:28:06 -04:00
Andreas Kling
a6e08e85d2 Meta: Update maintainer section in CONTRIBUTING.md 2023-08-04 12:37:44 +02:00
Andreas Kling
b6d9b3e886 Meta: Update maintainer list in CONTRIBUTING.md 2023-08-04 09:59:09 +02:00
Timothy Flynn
388d455575 Meta: Switch to clang-format-16 as the standard formatter
This includes a few new options to the .clang-format configuration file
to A) adhere to option changes within clang-format 16 (namely the option
AlignTrailingComments), and B) enforce existing style guide rules with
new clang-format rules.
2023-07-08 10:32:56 +01:00
thankyouverycool
683c8284cf Meta: Fix a typo in CONTRIBUTING.md 2023-04-24 16:48:37 +01:00
Andreas Kling
6a5be5f1c5 Meta: Add Jelle Raaijmakers to list of project maintainers :^) 2023-01-05 00:32:05 +01:00
Andrew Kaster
77a22268c6 Documentation: Describe extra clang tools built alongside BuildClang.sh
Also rephrase some of the information on updated clang-format binaries
2022-12-10 03:00:24 -07:00
Liav A
bef9ad4e44 Meta: Update all references of clang-format-14 to clang-format-15
Also, we add a section that describes how to get an updated clang-format
with multiple possible options to do that.
2022-12-04 09:13:24 -07:00
Andreas Kling
e5a353902d Meta: Add Andrew Kaster to list of project maintainers :^) 2022-10-09 15:16:06 +02:00
Andreas Kling
f4243790b4 Meta: Add Sam Atkins to list of project maintainers :^) 2022-06-15 17:36:04 +02:00
Andreas Kling
81cca937b1 Meta: Add note to CONTRIBUTING.md about jokes
Jokes don't scale well, and if everyone adds their pet "funny" thing
to the project, we'll just look unserious and goofy.

To avoid that, and maintain a dignified style, let's just have a blanket
ban on jokes and "funny" things in user-facing parts of the system.
2022-06-14 09:20:08 +02:00
Dennis Esternon
c0e3d453c0 Base: Add note about optipng to contributing guidelines
A trick I learned from @linusg which is very useful and needs
to be a part of PRs where images are involved.
2022-05-04 11:16:24 +02:00
Julen Ruiz Aizpuru
343aec2200 Meta: Fix grammar in CONTRIBUTING.md
It needs a plural instead of the possesive form.
2022-04-09 18:19:00 +01:00
Idan Horowitz
50c4ba0756 Meta: Update required clang-format version in CONTRIBUTING.md 2022-04-02 17:35:27 +03:00
Andreas Kling
2925725c9a Meta: Add Tim Flynn to list of project maintainers :^) 2022-02-11 22:24:10 +01:00
Andreas Kling
ec74afdb8d Meta: Discourage excessive "feng shui programming" in CONTRIBUTING.md 2022-01-08 16:31:14 +01:00
Jonta
0306cf2030 Docs: Fixed grammar "diagnose what is the problem" 2021-12-12 11:36:23 -08:00
Andreas Kling
6b32b775bf Meta: Add note about ideologically motivated changes to CONTRIBUTING.md 2021-12-02 12:20:52 +01:00
Linus Groh
ae7656072a Meta: Tighten rules around commit categories in CONTRIBUTING.md
These are the rules we have implicitly used & preferred for a while.
Document them explicitly.
2021-11-21 20:20:57 +01:00
Andreas Kling
47b8d80864 Meta: Add note about abandoned PR's to CONTRIBUTING.md 2021-10-29 22:59:44 +02:00
Andreas Kling
5017cc2bd3 Meta: Add Idan Horowitz as a project maintainer :^) 2021-09-07 22:16:25 +02:00
Andreas Kling
6696d414d4 Meta: Add Brian Gianforcaro as a project maintainer :^) 2021-09-07 22:16:25 +02:00
Andreas Kling
36c8b1c58c Meta: Update CONTRIBUTING.md
- Rename "reviewers" to "maintainers" to disambiguate, since everyone
  is encouraged to participate in code review.

- Clarify that maintainership is by invitation only and unrelated to
  participation metrics.
2021-07-09 10:18:24 +02:00
Idan Horowitz
7d40987ab6 Meta: Add a note about commit hooks to the contribution guide
These are pretty useful but are not documented anywhere, so this should
fix that :^)
2021-07-06 17:32:46 +01:00
Linus Groh
33a341f5e1 Meta: Add Gunnar to the project reviewers in CONTRIBUTING.md :^) 2021-07-02 22:04:26 +01:00
networkException
472721b774 Everywhere: Use new discord invite url :^)
Replaces all instances of the previous discord invite link
with a shiny new vanity url.
2021-06-14 22:41:37 +01:00
Andreas Kling
b07b890ce4 Meta: Request that new contributors don't start with new app/lib
It's strongly preferred that new contributors get comfortable with the
system and the project by working on smaller and/or existing things
before adding entirely new components to it.
2021-06-14 12:57:35 +02:00
Andreas Kling
5b47e9b39a Meta: Remove references to the abandoned IRC channel 2021-06-09 18:38:25 +02:00
Nick Miller
73b8acf432 CONTRIBUTING.md: Add Pull Request Q&A section
This is an attempt to clarify general pull request etiquette.
Answers are copied verbatim from `@awesomekling`'s responses in Discord.
2021-06-07 20:08:35 +02:00
Liav A
43e7181ec8 Meta: Add a guideline about bare metal issues 2021-06-03 20:59:49 +02:00
Brian Gianforcaro
2b10c34f5c Meta: Clarify atomic commits in CONTRIBUTING.md 2021-05-23 08:38:30 +02:00
Linus Groh
84b4b06c4b Meta: Discourage commit subject lines ending with a period 2021-05-16 00:33:47 +01:00
Andreas Kling
aea709de31 Meta: Add note about writing commit subjects in the imperative mood 2021-05-14 16:45:27 +02:00
Andreas Kling
89febfcd30 Meta: Specify that we use ISO 8601 dates and the metric system 2021-05-14 13:21:47 +02:00
Andreas Kling
88803b2e34 Meta: Add "Human language policy" to CONTRIBUTING.md 2021-05-05 23:15:08 +02:00
Andreas Kling
bebdf24329 Meta: Add note to CONTRIBUTING.md about pointless GitHub comments 2021-04-29 10:34:02 +02:00
Andreas Kling
910edb1e0c Meta: Simplify & clarify CONTRIBUTING.md somewhat
Also remove the feature policy section, since it was mostly fluff.
It was nice fluff, but made the document less focused.
2021-04-29 10:34:02 +02:00
Andreas Kling
42bfaef0bb Meta: Add note about new people making large architectural changes
Ideally, new contributors should hack on the system for a while before
attempting to make large architectural changes.

This will help ensure that architectural work is more in line with
the project direction, and that everyone's time is better spent.
2021-04-21 19:41:15 +02:00
Andreas Kling
8cada904cc Meta: Add a note about spell checking to CONTRIBUTING.md
It's silly to waste review cycles on spelling, so let's ask that
everyone check their spelling before submitting code.
2021-04-18 16:37:30 +02:00
Andreas Kling
a959ccc1d0 Meta: Add link to Discord in CONTRIBUTING.md 2021-04-13 18:27:36 +02:00
Andreas Kling
649564585e Meta: Encourage people to add their personal copyright lines 2021-04-08 22:03:28 +02:00
Linus Groh
fb220d5678 Meta+Docs+CI: Require clang-format >= 11 2020-12-31 21:51:00 +01:00
Linus Groh
352e0196e1 Meta: s/Travis/GitHub Actions/ in CONTRIBUTING.md 2020-11-12 10:16:45 +01:00
Emanuele Torre
0d5b43552d Meta: Update C++ standard to C++20 in CONTRIBUTING.md
We are compiling with `-std=c++2a` and we are using some C++20 features,
e.g. in Kernel/VM/Region.h
    bool m_shared : 1 { false };
    bool m_user_accessible : 1 { false };
    bool m_cacheable : 1 { false };
    bool m_stack : 1 { false };
    bool m_mmap : 1 { false };
2020-05-27 11:22:14 +02:00
Linus Groh
85f2987848 Docs: Update required clang-format version to 10 in CONTRIBUTING.md 2020-05-15 12:26:23 +02:00
Andreas Kling
2fdeb464f7 Meta: Add a basic "issue policy" to CONTRIBUTING.md 2020-05-04 13:49:15 +02:00
Conrad Pankoff
f1a074a262 Meta: Add feature policy to contribution guidelines 2020-03-28 10:57:09 +01:00
Dov Alperin
dacec1a7ee Meta: Reference CodingStyle doc in CONTRIBUTING.md 2020-01-08 19:41:20 +01:00
Andreas Kling
0c4c4c48f2 Meta: Remove CoC (lol) from CONTRIBUTING.md since it has its own file 2019-10-23 12:19:41 +02:00
Andreas Kling
62b8cf6644 Meta: Move code of conduct (lol) to a separate file 2019-10-23 10:05:06 +02:00