Commit Graph

36 Commits (00bf27a43e7ab86415d6eeb5014462a866cd68e8)

Author SHA1 Message Date
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
Ruben Vereecken 4186ed1a52 Added contributing guidelines on tldr-lint 2016-01-21 12:36:43 +01:00
Igor Shubovych 72196b030d Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
Waldir Pimenta 9b43655e35 small tweaks to CONTRIBUTING.md 2016-01-08 02:01:59 +00:00
Ruben Vereecken 2c1a6f14d6 Edited CONTRIBUTING.md to reflect final convention. 2016-01-07 20:59:18 +01:00
Igor Shubovych 3ae5617405 Improve Contributing Guidelines 2016-01-03 14:30:19 +02:00
Igor Shubovych 76f94dfac2 Improve Contributing Guidelines:
- mention feature branches
- have detailed workflow to work with pull requests
- move it to the bottom
- add link to license
- some minor fixes
2015-12-29 02:36:49 +02:00
Waldir Pimenta 3d78b46ada Merge pull request #381 from igorshubovych/remove-index-mention-from-contributing
Remove index mention from Contributing.md guidelines
2015-12-26 02:11:39 +00:00
Igor Shubovych 57edcb9456 Numbered list of rules in Contributing Rules instead of bulled list 2015-12-25 12:20:32 +02:00
Igor Shubovych 27f45ec45d Remove index mention from Contributing Guidelines 2015-12-25 12:11:51 +02:00
Waldir Pimenta 918379c482 remove obsolete paragraph
also revert US/UK spelling change
2015-08-25 04:07:19 +01:00
Waldir Pimenta daef03a298 rework/expand
- merge do's and don'ts, since they had mostly the same advice
- move token formatting info to the guideline section and the markdown section, as appropriate
- tweak spelling and fix a couple typos
- fix options vs. values in the formatting example, and add a token there.
2015-08-25 01:16:26 +01:00
Ruben Vereecken 1e157d94ed Update CONTRIBUTING.md
Explained the use of the Makefile to setup the git pre-commit hook that rebuilds the index.
2015-04-12 21:54:27 +02:00
Romain Prieto c4e3018b9f Contrib notes: check existing pull requests 2014-03-08 23:55:36 +11:00
Romain Prieto c9b4a4aba2 Contrib notes: Markdown format + token format 2014-03-08 23:52:52 +11:00
rprieto 8d6fa5235c New README & CONTRIBUTING that apply to pages only 2014-03-04 23:39:34 +11:00