Commit Graph

65 Commits (e01871f1c9bd78149c2bb6dfe2ae2630847b6e1f)

Author SHA1 Message Date
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
Waldir Pimenta cab0111b17 CONTRIBUTING: streamline token guidelines (#1161)
- moved one entry from the general guidelines, since now there's a specific section for tokens;
- reordered and numbered the entries, for clarity and ease of reference
- rewrote some passages for clarity and conciseness.
2016-11-20 11:35:49 +00:00
Waldir Pimenta f0d4c1647e CONTRIBUTING.md: max number of commands per page
as discussed in #1149
2016-11-19 17:16:19 +00:00
Waldir Pimenta d43187b364 contributing.md: adjust line-wrapping 2016-10-14 19:19:37 +01:00
Yash Sharma 1cf7bc7a63 add new guideline in CONTRIBUTING.md (#1116)
* Update CONTRIBUTING.md

* add missing quotes in contributing.md

* Update CONTRIBUTING.md
2016-10-14 20:11:41 +02:00
Waldir Pimenta 9e6d1b32f9 add badges to contributing.md
as [discussed in Gitter](https://gitter.im/tldr-pages/tldr?at=57ee0623b0ff456d3ad23195).
2016-10-02 11:08:44 +01:00
Waldir Pimenta 03f947196b contributing.md: various tweaks (#1100)
- adjust whitespace & line breaks to make the markdown source more readable and consistent
- remove "we"/"our", to avoid reinforcing the "us vs. them" paradigm
- clarify a couple passages
- remove obsolete license agreement notice, now covered by the CLA
- remove redundant (and oddly specific) plea for contributions and the end of the document,
  since there's already one at the beginning
- remove a redundant example of commit message format
2016-10-02 11:03:37 +01:00
Waldir Pimenta 6f72422422 add CLA to contributing.md (#1048) 2016-09-24 18:03:50 +01:00
Agniva De Sarker beb517b6a8 CONTRIBUTING.md: Add token conventions (#981)
* CONTRIBUTING.md: Add token conventions

* Shortening the token guidelines

* Minor spacing fix

* Addressing further concerns

* Replacing - by :
2016-08-12 09:45:35 +02:00
Waldir Pimenta d3f5b7f457 add subsections to "submit a PR" section (#974)
* add subsections to "submit a PR" section

this allows the reader to visually separate the instructions and makes the longer git-command section less prone to trigger a TLDR (heh) when reading this part.

also, line wrapping tweaks, split a paragraph into two, and reword a couple passages for clarity

* compact the list of git commands
2016-07-26 11:32:22 +02:00
Waldir Pimenta 8d61f0c757 CONTRIBUTING: greatly simplify the PR instructions (#962)
* CONTRIBUTING: greatly simplify the PR instructions

plus some wording tweaks here and there

* improve instructions to use tldrl

* brace expansion is not as common in the wild

removing it keeps the examples of unix features to a manageable/readable 3

* use actual commands in the git section

* use only one-liners on the git section

* add subsection header for commit message

* slight reword of licensing note
2016-07-24 09:05:21 +02:00
Waldir Pimenta 2109e464f7 CONTRIBUTING.md: minor grammar fix 2016-07-19 14:54:26 +01:00
Igor Shubovych 19aa8ed81f Fix Contributing Guidelines: remove make mentions, add npm mentions 2016-01-29 15:50:48 +02:00
Ruben Vereecken c13b3df271 Added line on Travis 2016-01-24 23:37:37 +01:00
Ruben Vereecken 90a22b69cb Added more notes on tldr-lint 2016-01-22 00:35:37 +01:00
Ruben Vereecken 8d1182f2fc Added contributing guidelines on tldr-lint 2016-01-21 13:38:22 +01:00