Commit Graph

80 Commits (171b82267f3e4d3c2f9f0cff8c85606ca451d3e2)

Author SHA1 Message Date
Vítor Henrique 5e6dc70b2c
style-guide: organize content and update sections; *: fix Markdownlint errors (#12148)
* style-guide: organize content and add contents section

* style-guide: fix general writing section title

* style-guide: fix heading level of help and version commands

* style-guide: fix heading level of see also section

* cleanup: update files

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* contributing: fix page for markdown lint

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* fix: markdownlint errors across files

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* docs: improve documentation about keycaps

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* docs: add info about optional and string placeholders

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* cleanup: sync changes with recent versions of style guide

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* cleanup: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs/style-guide: reword more info links section

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-04-22 09:20:17 +05:30
Vitor Henrique d77ae17016
CONTRIBUTING: document the directory structure (#12314)
* CONTRIBUTING: document the directory structure

* CONTRIBUTING: rename the subtitle "Pages directory" to "Directory structure"

* CONTRIBUTING: fix casing of platforms list

* CONTRIBUTING: use plural form of "directory"

Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>

* CONTRIBUTING: remove "valid reason"

* CONTRIBUTING: change platform directory listing for a numbered list format

* CONTRIBUTING: apply suggestions from code review

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

---------

Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-02-25 16:18:36 +05:30
Vitor Henrique 4e7c465342 CONTRIBUTING: use and instead of / when mentioning commit messages and PR titles 2024-02-15 09:56:32 +05:30
Vitor Henrique c4fcb8bf47 CONTRIBUTING: add commit message/PR title for a script addition 2024-02-15 09:56:32 +05:30
Vitor Henrique f25ff6b6b7 CONTRIBUTING: improve commit message/PR title for script changes 2024-02-15 09:56:32 +05:30
Vitor Henrique abe30f91ac CONTRIBUTING: mention PR title in commit message section 2024-02-15 09:56:32 +05:30
Vitor Henrique db6d109a94
CONTRIBUTING: emphasize right use of placeholders (#11946)
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-31 14:04:58 +01:00
K.B.Dharun Krishna f91917f3e4
cleanup: update contributing guide (#11861)
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-28 17:31:43 +01:00
K.B.Dharun Krishna 27c6fcc0ec CONTRIBUTING: minor fixes
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
2023-12-08 03:30:02 +00:00
K.B.Dharun Krishna 1683b15205 CONTRIBUTING: add tip about pre-commit hook
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-08 03:30:02 +00:00
K.B.Dharun Krishna 4c0855c7e3 CONTRIBUTING: fix typo
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-08 03:30:02 +00:00
K.B.Dharun Krishna 246e151e8f CONTRIBUTING: fix typo 2023-12-08 03:30:02 +00:00
K.B.Dharun Krishna 6bf91f8050 cleanup/contributing: update page
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-08 03:30:02 +00:00
Lena 7856124245
docs: use the new `[!NOTE]` syntax (#10959)
* style-guide: use the new note syntax
* MAINTAINERS: use the new note syntax, use full month names
* CONTRIBUTING: use the new note syntax
* maintainers-guide: use the new note syntax
* CLIENT-SPECIFICATION: use the new note syntax
* COMMUNITY-ROLES: use the new note syntax
* git-terminal: use the new note syntax

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-13 01:26:58 +02:00
K.B.Dharun Krishna 46ab966a5a
Community: Update Gitter links to Matrix, Update Badges, Remove editor extensions (#9898)
* Community: Update Gitter links to Matrix

* Update MAINTAINERS Chatroom links (2021-2013)

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* Update Final Gitter Links with Issue, Fix wrong date

* COMMUNITY-ROLES: add Matrix link

* Remove Space in Issue template

* Apply suggestions from code review

Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>

* Update MAINTAINERS.md

* Update matrix badge

* CONTRIBUTING: Update matrix badge

* README: Update badges

* CONTRIBUTING: Update badges

* README: Remove editor extensions

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>
2023-03-27 10:44:21 +05:30
dz-at-tc 9f58eca0d3
CONTRIBUTING: fix typo caja to tar (#8666) 2022-10-02 16:00:45 -03:00
Cornelius Roemer 3648227344
contributing(doc): fix typo 'simpliest' -> 'simplest' (#8420) 2022-08-28 20:31:43 +00:00
Emily Grace Seville 5b1acd3a89
CONTRIBUTING: add notes about placeholders and some examples (#8366)
* Add notes about placeholders and some examples

* Apply suggestions from code review

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>

* Use `tokens` instead of `things`

Co-authored-by: Muhammad Falak R Wani <falakreyaz@gmail.com>

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
Co-authored-by: Muhammad Falak R Wani <falakreyaz@gmail.com>
2022-08-24 18:50:36 +10:00
Muhammad Falak R Wani 0bbe0c1310
CONTRIBUTING: clarify guideline for new PRs (#7450) 2021-11-17 23:45:16 +05:30
Sherman Hui 8b531c09bb
CONTRIBUTING, git-terminal: explain common contrib issues (#7107) 2021-10-27 14:51:53 -03:00
9tykeshav 7fcc57d205
CONTRIBUTING: fix link to alias-pages (#6626) 2021-10-01 15:37:02 -03:00
marchersimon bd677b8b48
mention subcommands in every base page (#6383) 2021-09-13 10:21:21 +02:00
Miles Glapa-Grossklag 35e8bae324
contributing: follow style guide (#6416)
> Introduce options gradually, starting with the simplest command
> invocations, and using more complex examples progressively.
2021-08-27 09:17:27 +05:30
marchersimon f7f16b8502
Add contributing-guides/alias-pages.md (#5988)
Co-authored-by: Abhishek Keshri <keshri.abhishek63@gmail.com>
Co-authored-by: ktrueda <kentaro.ueda.kentaro@gmail.com>
Co-authored-by: Arun Isaac <arunisaac@systemreboot.net>
Co-authored-by: Merjem Bajramovic <merjembajramovic8@gmail.com>
Co-authored-by: Levi Rizki Saputra <42236775+levirs565@users.noreply.github.com>
Co-authored-by: Natechawin Suthison <natechawin@gmail.com>
Co-authored-by: noarchwastaken <noarch@n0ar.ch>
Co-authored-by: Tristan <code@thewoosh.me>
Co-authored-by: Abraham Raji <abrahamraji99@gmail.com>
Co-authored-by: Grzegorz Koperwas <grzes869@gmail.com>
Co-authored-by: Anton Khlynovskiy <subzey@gmail.com>
Co-authored-by: Allan Nordhøy <epost@anotheragency.no>
Co-authored-by: Marco Bonelli <marco@mebeim.net>
Co-authored-by: Patrice Denis <patrice.denis@gmail.com>
Co-authored-by: bl-ue <bl-ue@users.noreply.github.com>
Co-authored-by: navarroaxel <navarroaxel@gmail.com>
2021-06-21 13:17:29 -04:00
bl-ue 8ebd171d6f
*: fix typos reported by Hunspell (#5848)
Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
Co-authored-by: Seth Falco <seth@falco.fun>
Co-authored-by: Patrice Denis <patricedenis@users.noreply.github.com>
2021-05-20 16:13:41 -04:00
Owen Voke a66723d2c5 docs: update references to 'main' branch 2021-05-01 20:10:05 +01:00
FantasyCookie17 04a78338e7
CONTRIBUTING: improve wording about example count limit (#5760) 2021-04-15 14:16:25 -03:00
bl-ue d66eae6c32
CONTRIBUTING, README: add link to https://lukwebsforge.github.io/tldri18n (#5378) 2021-03-08 17:46:52 -03:00
Lucas Gabriel Schneider d15093cf45 Update CONTRIBUTING.md 2021-01-08 13:09:54 +00:00
Quinn Vissak 0c9f1209d1
GOVERNANCE.md, CONTRIBUTING.md: add inclusive language blurb (#4516) 2020-11-03 19:12:50 +00:00
Jacob Hrbek d715edf785
CONTRIBUTING: Include homepage in example (#4270)
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
2020-08-24 18:10:29 +01:00
Waldir Pimenta b925b8366c
Tweak badge colors in README.md and CONTRIBUTING.md (#4110) 2020-06-19 00:38:47 +02:00
Waldir Pimenta 8adbef5d5a CONTRIBUTING: remove issue stats badge 2020-06-17 18:31:20 +02:00
Waldir Pimenta 37634b36f7 Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) 2020-05-27 22:22:32 +02:00
fejx 677d76b1af
Add subcommand section to contributing guidelines (#4025) 2020-05-10 00:10:23 +01:00
Zlatan Vasović ec40569bde
Update the LICENSE information (#3997) 2020-04-22 19:02:32 +08:00
LinuxOnTheDesktop 9537f5f6ae Update CONTRIBUTING.md (#3776)
I have fixed a grammatical mistake (specifically, a lack of number agreement). Previously, the sentence in question did not, construed strictly, make sense. Also, I'm doing this to practice doing pull requests!
2020-01-23 01:09:12 +01:00
Zlatan Vasović 954f0e62dc Use GitHub consistently 2019-12-09 13:02:55 +05:30
Agniva De Sarker d76e3a4a5e CONTRIBUTING: remove mention of BCP47 (#3255) 2019-08-26 09:43:23 +01:00
Marco Bonelli 649f5eced0 BCP47 to POSIX: update CONTRIBUTING.md to use POSIX tags. 2019-08-26 09:53:30 +05:30
Marco Bonelli 5dd4d97a45 Contributing: simplify translation guidelines.
Cleaned up translation guidelines:

- Reworded and simplified the first paragraph.
- Do not require the optional BCP47 region code for language tags.
- Do not require the existence of the relative English page before
  adding a new page in a different language.
- Fix spelling and wording.
2019-01-15 15:32:58 +00:00
Marco Bonelli 572be85f54 Contributing: clarifications on translation languages. 2019-01-15 15:32:58 +00:00
Marco Bonelli f5f12b390a Add contribution guidelines for translations. 2019-01-15 15:32:58 +00:00
Waldir Pimenta c2fc8203ae Update Contribution guidelines and PR template (#2575) 2018-11-13 23:39:53 +00:00
Waldir Pimenta 29025a48a3 link to GOVERNANCE.md from README.md and CONTRIBUTING.md 2017-12-27 23:33:55 +00:00
Agniva De Sarker 4b638bfc34
Fix incorrect link to style guide 2017-11-29 11:41:28 +05:30
Waldir Pimenta e2ab1818f1 docs overhaul: move git cli instructions to a separate file 2017-11-28 09:01:47 +05:30
Amy Martin f3c002d32f Extract STYLEGUIDE.md from CONTRIBUTING.md 2017-11-26 13:04:07 +05:30
Muhammad Falak Reyaz Wani 80dae3da6e CONTRIBUTING: add missing args to git push (#1554) (#1560) 2017-10-21 21:53:02 +01:00
Waldir Pimenta 73ec3a8811 fix link to CLA (#1367)
the cla-assistant link leads to a page requesting the user to sign it, which may not be as friendly
since prospective contributors may want to simply read the CLA without a prompt to sign it.
2017-05-06 11:41:39 +01:00