Commit Graph

38 Commits (master)

Author SHA1 Message Date
Anthony Bilinski 345e33b531
chore(docs): Remove generic git instructions from docs
General version control, git, or github instructions can be found in abundance
elsewhere. Keep qTox docs more focused on qTox.
2022-02-20 16:29:40 -08:00
Anthony Bilinski 5d459d2fda
chore(docs): Remove mentions of travis from docs 2022-02-19 03:31:48 -08:00
cryptogospod 58d3b26af2
docs(CONTRIBUTING): Update IRC info 2021-09-18 03:04:34 +02:00
Zetok Zalbavar a88e6e4690
docs: add to CONTRIBUTING.md Git config line for forcing singning tags
Also change git config from global, to local, specific to repo, since
signing all commits in every project committed to might not be desirable
for some people, as GPG-signing usually involves typing in password,
which is a slowdown.

Partially addresses cause of #5125 and #5274.
2018-07-27 19:27:29 +01:00
Jakie.OYMJ a6c3902f98 docs: correct typo in CONTRIBUTING.md 2018-07-19 18:40:18 +08:00
jakie.oymj 6efe28b133 docs(CONTRIBUTING):add a step within 'How to open a pull request' 2018-07-14 08:13:19 +08:00
Diadlo 6e0bdf2cd2
chore: Remove qtox.pro and its mention 2017-10-02 00:01:25 +03:00
Zetok Zalbavar b173d4677c
docs(CONTRIB): add index of sections to CONTRIBUTING.md
Should help people who feel lost scrolling through lots of stuff there.
2017-03-27 15:44:36 +01:00
Zetok Zalbavar 21195d363a
docs: slightly improve link formatting and remove trailing whitespaces 2017-02-26 09:51:50 +00:00
initramfs e4d40f11ed
docs(clangformat): add documentation on coding style with respect to clang-format 2017-02-26 09:51:49 +00:00
Zetok Zalbavar 8c1632df45
docs(CONTRIBUTING): reword `revert` section to use the default message 2017-02-08 18:04:15 +00:00
sudden6 6bad4ad3ba
chore(style): add coding style file for Qt Creator 2017-01-04 17:07:32 +01:00
Zetok Zalbavar d4ac13dbf4
revert: "refactor: Added to include path and exclude it from all includes"
Revert needed, since otherwise there is no way to do automatic sorting
of includes.
Also reverted change to the docs, as leaving it would make incorrect
docs.

In case of conflicts, includes were sorted according to the coding
standards from #3839.

This reverts commit b4a9f04f92.
This reverts commit 5921122960.
2016-12-29 16:10:53 +00:00
Diadlo 5921122960
docs: Updated includes rules in CONTRIBUTING.md 2016-11-28 23:28:42 +03:00
Zetok Zalbavar 7a18efaf4a
docs(CONTRIBUTING): state the correct way of using CONTRIBUTING.md 2016-11-23 21:40:25 +00:00
Zetok Zalbavar ce9406c959
docs: move `Reviews` section and add `Testing PRs` section
Since anyone, not just maintainers can review PRs.
2016-10-25 08:59:49 +01:00
Zetok Zalbavar 1c2b271716
docs(CONTRIBUTING): change style to always require curly brackets
RE: #3601
2016-10-22 22:32:25 +01:00
Zetok Zalbavar cefe17651a
docs(CONTRIBUTING): add more info about shape of PRs
Text taken from spacemacs @ 3706a42c4346dc555b8e46bea220617ce11a9ddb,
under GPLv3 and adjusted for qTox needs.

3706a42c43/CONTRIBUTING.org
2016-10-14 22:04:57 +01:00
sudden6 84208d0b3f
docs(CONTRIBUTING): add section about include styles 2016-10-12 13:59:33 +02:00
Zetok Zalbavar abaa41eaee
docs(CONTRIBUTING): add a guideline to not use dynamic casts/RTTI
And enforce it during compilation.
2016-09-29 14:53:21 +01:00
Zetok Zalbavar 557ad33614
Merge pull request #3491
Nils Fenner (1):
      docs(CONTRIBUTING): rewrite "HowTo contribute" section
2016-08-26 15:33:57 +01:00
Nils Fenner 2a984c16f1 docs(CONTRIBUTING): rewrite "HowTo contribute" section 2016-08-26 16:14:05 +02:00
Diadlo 2be8929f38
docs(CONTRIBUTING): Changed docs format
Fix #3559.
2016-08-19 00:20:23 +03:00
Zetok Zalbavar b55933281f
docs(CONTRIBUTING): add some real examples of scopes
It became apparent in #3574 that it's not clear what scope should be.

Added `CONTRIBUTING` as suggested by @Diadlo.
Added `build` as suggested by @initramfs.

Also improve formatting of the file, so that it will conform to <=80
chars per line for markdown.
2016-08-06 13:06:28 +01:00
Zetok Zalbavar 34aa9051e3
chore: limit scope of commit messages to dozen characters 2016-08-04 20:08:37 +01:00
initramfs b7aa982a57
chore: rewrite all links to the qTox repository from tux3 to qTox 2016-08-04 06:25:50 +08:00
Zetok Zalbavar 78427b8e6b
docs(CONTRIBUTING.md): make more explicit what commit message needs
By clearly stating what commit message needs to have.
Should help with commit messages that aren't really clear.
2016-07-28 20:32:08 +01:00
Diadlo 7bee05eff1
docs(CONTRIBUTING.md): Added documntation block 2016-07-27 23:39:22 +03:00
tux3 4eed2549aa
fix(doc): CONTRIBUTING.md typos 2016-07-03 13:30:21 +02:00
RegZi 02cacea6fd
docs(CONTRIBUTING.md): change type descriptions for less confusion 2016-07-03 13:28:40 +03:00
sudden6 899a2eb555
docs(CONTRIBUTING.md): change obsolete link 2016-04-28 20:49:02 +02:00
Zetok Zalbavar 7342a57638
docs(CONTRIBUTING.md): add coding guidelines (moved from wiki) 2016-04-18 04:12:20 +01:00
kehugter f82a74a4bc style(Markdown): wrap all .md files at 80 characters
Short lines make it easier to evaluate diffs.
Fix only critical typos, like missing full stops in the middle of a
sentence. Everything else left untouched.
2016-04-09 23:57:31 +02:00
kehugter da58b65059 style: enhance and reformat issue template
Add missing required information for new issues
Redo Markdown format for a cleaner raw display
Standarise requirements/terms with CONTRIBUTING.md
2016-04-08 10:23:11 +02:00
kehugter f5c099175c docs: edit and reorganize Git Commit Guidelines
Reorganize the Git Commit Guidelines title hierarchy.
Various content edits in the Git Commit Guidelines section:
- Remove the footer section and merge its contents with the body
- Add revert to the list of possible header types
- Change the maximum line length for header and body
- Add instructions about the body's elements order
2016-04-06 22:56:50 +02:00
Zetok Zalbavar 99bf6aeec6
docs(CONTRIBUTING.md): add section about commit message format
With a proper, (not yet) enforced commit message format qTox would get
both clean commit messages and automatically generated changelog.

In regard to #2887.

Content of the commit taken from `CONTRIBUTING.md` @
96e2cec95a
and adjusted for qTox needs.
2016-03-29 00:20:22 +01:00
SeventhSonOfASeventhSon a2d130f804 Fixed grammatical errors 2016-02-08 16:24:52 +00:00
Zetok Zalbavar 910264a7d6
Add CONTRIBUTING.md
It was taken from 76c16e0994/CONTRIBUTING.md
and adjusted for qTox needs.

Since qBittorrent is licensed under GPLv2+, file in qTox source is covered by
GPLv3+.
2015-12-31 13:18:57 +00:00