From 2a6cd97e1bbb08cff7a247087e869090164f6c8c Mon Sep 17 00:00:00 2001 From: John Bytheway Date: Fri, 17 Jan 2020 05:29:06 +0000 Subject: [PATCH] Updates to the contributing docs (#37133) * Link to CONTRIBUTING.md from doc folder The CONTRIBUTING.md is hidden inside .github, because that's where it needs to be for GitHub to find it. But it contains useful information people might look for in the docs too, so symlink it from the doc directory. * Update CONTRIBUTING.md Update a few aspects of this file which had become out of date. Link to the DEVELOPER_FAQ.md from the FAQ section at the end. * Move GUIDE_COMESTIBLES.md into doc Not sure how it was ever in the top-level directory. --- .github/CONTRIBUTING.md | 54 ++++++------------- doc/CONTRIBUTING.md | 1 + .../GUIDE_COMESTIBLES.md | 0 3 files changed, 18 insertions(+), 37 deletions(-) create mode 120000 doc/CONTRIBUTING.md rename GUIDE_COMESTIBLES.md => doc/GUIDE_COMESTIBLES.md (100%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 32e97bc510a0a..e9ee9eb178160 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribute -**Opening new issue?** Please read [ISSUES.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/ISSUES.md) first. +**Opening new issue?** Please read [ISSUES.md](../ISSUES.md) first. Contributing to Cataclysm: Dark Days Ahead is easy — simply fork the repository here on GitHub, make your changes, and then send us a pull request. @@ -18,7 +18,8 @@ There are a couple of guidelines we suggest sticking to: ## Code Style -Current policy is to only update code to the standard style when changing a substantial portion of it, but **please** do this in a separate commit. See [CODE_STYLE](../doc/CODE_STYLE.md) for details. +Code style is enforced across the codebase by `astyle`. +See [CODE_STYLE](../doc/CODE_STYLE.md) for details. ## Translations @@ -232,7 +233,7 @@ You can also set the tracking information at the same time as creating the branc There is a suite of tests built into the source tree at tests/ You should run the test suite after ANY change to the game source. -An ordinary invocation of ``make`` will build the test executable at tests/cata_test, and it can be invoked like any ordinary executable. +An ordinary invocation of ``make`` will build the test executable at tests/cata_test, and it can be invoked like any ordinary executable, or via `make check`. With no arguments it will run the entire test suite. With ``--help`` it will print a number of invocation options you can use to adjust its operation. @@ -245,7 +246,7 @@ With ``--help`` it will print a number of invocation options you can use to adju Ended test at Fri Nov 9 04:37:45 2018 The test took 41.772 seconds -I recommend habitually invoking make like ``make YOUR BUILD OPTIONS && tests/cata_test``. +I recommend habitually invoking make like ``make YOUR BUILD OPTIONS && make check``. ## In-game testing, test environment and the debug menu @@ -254,39 +255,16 @@ Whether you are implementing a new feature or whether you are fixing a bug, it i Bring up the keybindings menu (press `Escape` then `1`), scroll down almost to the bottom and press `+` to add a new key binding. Press the letter that corresponds to the *Debug menu* item, then press the key you want to use to bring up the debug menu. To test your changes, create a new world with a new character. Once you are in that world, press the key you just assigned for the debug menu and you should see something like this: ``` -┌────────────────────────────────────────────┐ -│ Debug Functions - Using these is CHEATING! │ -├────────────────────────────────────────────┤ -│ 1 Wish for an item │ -│ 2 Teleport - Short Range │ -│ 3 Teleport - Long Range │ -│ 4 Reveal map │ -│ 5 Spawn NPC │ -│ 6 Spawn Monster │ -│ 7 Check game state... │ -│ 8 Kill NPCs │ -│ 9 Mutate │ -│ 0 Spawn a vehicle │ -│ a Change all skills │ -│ b Learn all melee styles │ -│ c Unlock all recipes │ -│ d Edit player/NPC │ -│ e Spawn Artifact │ -│ f Spawn Clairvoyance Artifact │ -│ g Map editor │ -│ h Change weather │ -│ i Remove all monsters │ -│ j Display hordes │ -│ k Test Item Group │ -│ l Damage Self │ -│ m Show Sound Clustering │ -│ n Lua Command │ -│ o Display weather │ -│ p Change time │ -│ q Set automove route │ -│ r Show mutation category levels │ -│ s Cancel │ -└────────────────────────────────────────────┘ +┌───────────────────────────────────────────────────────────────────────────┐ +│ Debug Functions - Using these will cheat not only the game, but yourself. │ +├───────────────────────────────────────────────────────────────────────────┤ +│ i Info │ +│ Q Quit to main menu │ +│ s Spawning… │ +│ p Player… │ +│ t Teleport… │ +│ m Map… │ +└───────────────────────────────────────────────────────────────────────────┘ ``` With these commands, you should be able to recreate the proper conditions to test your changes. You can find some more information about the debug menu on [the official wiki](http://cddawiki.chezzo.com/cdda_wiki/index.php). @@ -312,3 +290,5 @@ Now that `master` has been cleaned up, we can easily pull from `upstream/master` $ git pull --ff-only upstream master # gets changes from the "upstream" remote for the matching branch, in this case "master" $ git checkout new_branch + +For more frequently asked questions, see the [developer FAQ](../doc/DEVELOPER_FAQ.md). diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md new file mode 120000 index 0000000000000..e6afed18649a4 --- /dev/null +++ b/doc/CONTRIBUTING.md @@ -0,0 +1 @@ +../.github/CONTRIBUTING.md \ No newline at end of file diff --git a/GUIDE_COMESTIBLES.md b/doc/GUIDE_COMESTIBLES.md similarity index 100% rename from GUIDE_COMESTIBLES.md rename to doc/GUIDE_COMESTIBLES.md