Zandronum Chat @ irc.zandronum.com
#zandronum
Get the latest version: 3.0
Source Code

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0003595Doomseeker[All Projects] Documentationpublic2019-01-06 07:252019-06-23 09:42
ReporterWubTheCaptain 
Assigned ToZalewa 
PrioritynormalSeverityfeatureReproducibilityalways
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version1.2 
Target Version1.3Fixed in Version1.3 
Summary0003595: Contributor documentation is not yet available
DescriptionPeople will not likely find their way from the source distribution how to contribute to Doomseeker & Wadseeker.

I propose adding some text to README or creating a CONTRIBUTING file with this information, and more.
Attached Filespatch file icon 0001-Add-a-README-file-for-developers.patch [^] (6,308 bytes) 2019-06-23 02:22 [Show Content]
patch file icon 0002-README-dev-Add-linebreaks-etc-to-hg-clone-line.patch [^] (1,163 bytes) 2019-06-23 08:20 [Show Content]
patch file icon 0003-README-dev-Remove-section-on-unit-tests.patch [^] (1,052 bytes) 2019-06-23 08:20 [Show Content]

- Relationships
related to 0003237closedWubTheCaptain Non-free files and copyright issues in source archive 
related to 0003533acknowledgedZalewa Replace homebrew unit testing engine with Qt Test 
related to 0003514resolvedZalewa Drop support for compiling with Qt4 (in favor of Qt5+) 
parent of 0003591resolvedPol M Programming style (for formatting tools like clang-format or astyle) is undocumented 
child of 0003594confirmedWubTheCaptain Documentation sprint #1: Undocumented support & contributing READMEs 

-  Notes
User avatar (0020304)
WubTheCaptain (developer)
2019-01-06 07:25

Probably a link to our issue tracker, at least.
User avatar (0020311)
Pol M (developer)
2019-01-16 00:06

In ticket 3444 Zalewa makes some great points that should be included ^-^
User avatar (0020809)
WubTheCaptain (developer)
2019-06-23 02:22

Patch by me, attached.
User avatar (0020810)
WubTheCaptain (developer)
2019-06-23 02:29
edited on: 2019-06-23 02:29

Quote
Patch by me, attached.

Spoilers for references included:
  • Russian Overkill
  • Doom II maps, monster names, etc.
  • Push

This patch makes mentions to things which other tickets should consider with implementation. I'll try to find their relationships.

User avatar (0020812)
Zalewa (developer)
2019-06-23 07:08
edited on: 2019-06-23 07:09

It's straight to the point, just the way I like it.

Two remarks from me:

1. The .md format should maintain usability in the plain-text format as much as possible. This is achieved here, however I'd still like to nitpick about the `hg clone` line. Personally I prefer when command lines stand out in a way that makes them easy to copy and paste, especially if the command is short and fits within the column limit.


+A typical way to get started is to clone the Mercurial repository, using a
+Mercurial client from command line.
+
+ `hg clonehttps://bitbucket.org/Doomseeker/doomseeker [^]`.
+
+Refer to the manual of your client for information on interfacing
+with Mercurial.


2. The unit testing engine is not entirely useless. Yes, it's crude and doesn't automagically translate #define macros to test cases and fixtures, but it does its job if you know how to use it. Its pro point is that it's straight-forward. Everything to know about it is in the code and it doesn't need any obscure rituals to use. It's partially why I've been delaying its replacement for so long.

User avatar (0020813)
WubTheCaptain (developer)
2019-06-23 08:22

The first one is a fair point, although with CommonMark your exact example wouldn't do what you intended: the backticks would be visible. I addressed this in patch 0002, attached.

As for your second point, I've decided to remove the section on unit tests (for now).
User avatar (0020814)
Zalewa (developer)
2019-06-23 09:34

Merged the patches as-is:

1.https://bitbucket.org/Doomseeker/doomseeker/commits/44341d508b961e43c7d0fca1ffb21d5158ed1281 [^]
2.https://bitbucket.org/Doomseeker/doomseeker/commits/c9b9dcee3b4db3a9b5f353ba47349f15f9e51211 [^]
3.https://bitbucket.org/Doomseeker/doomseeker/commits/21392ebbfa73a797f61a01d0cd91569d5f53434f [^]

The end result is:https://bitbucket.org/Doomseeker/doomseeker/src/default/README-dev.md [^]

Looks good to me. Resolve?
User avatar (0020815)
WubTheCaptain (developer)
2019-06-23 09:40
edited on: 2019-06-23 09:41

I have personally used commonmark.js dingus as a reference for rendering, and thus don't really care for rendering issues which may be apparent on Bitbucket. (Maybe Bitbucket will improve or switch their renderer in the future.)

User avatar (0020816)
WubTheCaptain (developer)
2019-06-23 09:42

We'll probably mention this in the changelog later.

Issue Community Support
This issue is already marked as resolved.
If you feel that is not the case, please reopen it and explain why.
Supporters: No one explicitly supports this issue yet.
Opponents: No one explicitly opposes this issue yet.

- Issue History
Date Modified Username Field Change
2019-01-06 07:25 WubTheCaptain New Issue
2019-01-06 07:25 WubTheCaptain Note Added: 0020304
2019-01-06 07:26 WubTheCaptain Relationship added child of 0003594
2019-01-06 07:26 WubTheCaptain Assigned To => WubTheCaptain
2019-01-06 07:26 WubTheCaptain Status new => acknowledged
2019-01-06 07:26 WubTheCaptain Relationship added child of 0003591
2019-01-06 07:27 WubTheCaptain Relationship replaced parent of 0003591
2019-01-06 07:29 WubTheCaptain Status acknowledged => confirmed
2019-01-06 07:29 WubTheCaptain Target Version => 1.3
2019-01-16 00:06 Pol M Note Added: 0020311
2019-02-05 18:16 Pol M Note Added: 0020336
2019-02-05 18:16 Pol M Note Deleted: 0020336
2019-06-22 22:18 WubTheCaptain Status confirmed => assigned
2019-06-23 02:22 WubTheCaptain File Added: 0001-Add-a-README-file-for-developers.patch
2019-06-23 02:22 WubTheCaptain Note Added: 0020809
2019-06-23 02:22 WubTheCaptain Status assigned => needs review
2019-06-23 02:29 WubTheCaptain Note Added: 0020810
2019-06-23 02:29 WubTheCaptain Note Edited: 0020810 View Revisions
2019-06-23 02:29 WubTheCaptain Note Edited: 0020810 View Revisions
2019-06-23 02:33 WubTheCaptain Relationship added related to 0003237
2019-06-23 02:33 WubTheCaptain Relationship added related to 0003533
2019-06-23 02:36 WubTheCaptain Relationship added related to 0003514
2019-06-23 07:08 Zalewa Note Added: 0020812
2019-06-23 07:09 Zalewa Note Edited: 0020812 View Revisions
2019-06-23 08:12 WubTheCaptain Status needs review => assigned
2019-06-23 08:20 WubTheCaptain File Added: 0002-README-dev-Add-linebreaks-etc-to-hg-clone-line.patch
2019-06-23 08:20 WubTheCaptain File Added: 0003-README-dev-Remove-section-on-unit-tests.patch
2019-06-23 08:22 WubTheCaptain Note Added: 0020813
2019-06-23 08:22 WubTheCaptain Status assigned => needs review
2019-06-23 08:28 WubTheCaptain Assigned To WubTheCaptain => Zalewa
2019-06-23 09:34 Zalewa Note Added: 0020814
2019-06-23 09:40 WubTheCaptain Note Added: 0020815
2019-06-23 09:40 WubTheCaptain Status needs review => resolved
2019-06-23 09:40 WubTheCaptain Fixed in Version => 1.3
2019-06-23 09:40 WubTheCaptain Resolution open => fixed
2019-06-23 09:41 WubTheCaptain Note Edited: 0020815 View Revisions
2019-06-23 09:42 WubTheCaptain Note Added: 0020816






Questions or other issues? Contact Us.

Links


Copyright © 2000 - 2019 MantisBT Team
Powered by Mantis Bugtracker