Skip to content

Latest commit

 

History

History
223 lines (155 loc) · 10.3 KB

CONTRIBUTING.md

File metadata and controls

223 lines (155 loc) · 10.3 KB
Raw

Contribute

Opening new issue? Please read 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.

Cataclysm:Dark Days Ahead is released under the Creative Commons Attribution ShareAlike 3.0 license. The code and content of the game is free to use, modify, and redistribute for any purpose whatsoever. See http://creativecommons.org/licenses/by-sa/3.0/ for details. This means any contribution you make to the project will also be covered by the same license, and this license is irrevocable.

Guidelines

There are a couple of guidelines we suggest sticking to:

  • Add this repository as an upstream remote.
  • Keep your master branch clean. This means you can easily pull changes made to this repository into yours.
  • Create a new branch for each new feature or set of related bug fixes.
  • Never merge from your local branches into your master branch. Only update that by pulling from upstream/master.

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. Blocks of code can be passed through astyle to ensure that their formatting is correct:

astyle --style=1tbs --indent=spaces=4 --align-pointer=name --max-code-length=100 --break-after-logical --indent-classes --indent-switches --indent-preprocessor --indent-col1-comments --min-conditional-indent=0 --pad-oper --add-brackets --convert-tabs

For example, from vi, set marks a and b around the block, then:

:'a,'b ! astyle --style=1tbs --indent=spaces=4 --align-pointer=name --max-code-length=100 --break-after-logical --indent-classes --indent-switches --indent-preprocessor --indent-col1-comments --min-conditional-indent=0 --pad-oper --add-brackets --convert-tabs

Doxygen Comments

Extensive documentation of classes and class members will make the code more readable to new contributors. New doxygen comments for existing classes are a welcomed contribution.

Use the following template for commenting classes:

/**
 * Brief description
 *
 * Lengthy description with many words. (optional)
 */
class foo {

Use the following template for commenting functions:

/**
 * Brief description
 *
 * Lengthy description with many words. (optional)
 * @param param1 Description of param1 (optional)
 * @return Description of return (optional)
 */
int foo(int param1);

Use the following template for commenting member variables:

/** Brief description **/
int foo;

Helpful pages: http://www.stack.nl/~dimitri/doxygen/manual/commands.html http://www.stack.nl/~dimitri/doxygen/manual/markdown.html#markdown_std http://www.stack.nl/~dimitri/doxygen/manual/faq.html

Guidelines for adding documentation

  • Doxygen comments should describe behavior towards the outside, not implementation, but since many classes in Cataclysm are intertwined, it's often necessary to describe implementation.
  • Describe things that aren't obvious to newcomers just from the name.
  • Don't describe redundantly, /** Map **/; map* map; is not a helpful comment.
  • When documenting X, describe how X interacts with other components, not just what X itself does.

Building the documentation for viewing it locally

  • Install doxygen
  • doxygen doxygen_doc/doxygen_conf.txt
  • firefox doxygen_doc/html/index.html (replace firefox with your browser of choice)

Example Workflow

Setup your environment

(This only needs to be done once.)

  1. Fork this repository here on GitHub.

  2. Clone your fork locally.

     $ git clone https://github.com/YOUR_USERNAME/Cataclysm-DDA.git
 # Clones your fork of the repository into the current directory in terminal

  3. Add this repository as a remote.

     $ cd Cataclysm-DDA
 # Changes the active directory in the prompt to the newly cloned "Cataclysm-DDA" directory
 $ git remote add -f upstream https://github.com/CleverRaven/Cataclysm-DDA.git
 # Assigns the original repository to a remote called "upstream"

Update your master branch

  1. Make sure you have your master branch checked out.

     $ git checkout master

  2. Pull the changes from the upstream/master branch.

     $ git pull --ff-only upstream master
 # gets changes from "master" branch on the "upstream" remote

Make your changes

  1. Update your master branch, if you haven't already.

  2. For each new feature or bug fix, create a new branch.

     $ git branch new_feature
 # Creates a new branch called "new_feature"
 $ git checkout new_feature
 # Makes "new_feature" the active branch

  3. Once you've committed some changes locally, you need to push them to your fork here on GitHub.

     $ git push origin new_feature
 # origin was automatically set to point to your fork when you cloned it

  4. Once you're finished working on your branch, and have committed and pushed all your changes, submit a pull request from your new_feature branch to this repository's master branch.

  • Note: any new commits to the new_feature branch on GitHub will automatically be included in the pull request, so make sure to only commit related changes to the same branch.

Pull Request Notes

  • Mark pull requests that are still being worked on by adding [WIP] before the title
    • When a pull request is ready to be reviewed remove the [WIP]
  • Mark pull requests that need commenting/testing by others with [CR] before the title
    • [WIP] has higher precedence than [CR]. Feel free to remove [CR] when you feel you got enough information
  • If the pull request fixes a issue listed on github, include "fixes #???" into the text, where ??? is the number of the issue. This automatically closes the issue when the PR is pulled in, and allows mergers to work slightly faster. For further details see issue #2419.

Advanced Techniques

These guidelines aren't essential, but they can make keeping things in order much easier.

Using remote tracking branches

Remote tracking branches allow you to easily stay in touch with this repository's master branch, as they automatically know which remote branch to get changes from.

$ git branch -vv
* master      xxxx [origin/master] ....
  new_feature xxxx ....

Here you can see we have two branches; master which is tracking origin/master, and new_feature which isn't tracking any branch. In practice, what this means is that git won't know where to get changes from.

$ git checkout new_feature
Switched to branch 'new_feature'
$ git pull
There is no tracking information for the current branch.
Please specify which branch you want to merge with.

In order to easily pull changes from upstream/master into the new_feature branch, we can tell git which branch it should track. (You can even do this for your local master branch.)

$ git branch -u upstream/master new_feature
Branch new_feature set up to track remote branch master from upstream.
$ git pull
Updating xxxx..xxxx
....

You can also set the tracking information at the same time as creating the branch.

$ git branch new_feature_2 --track upstream/master
Branch new_feature_2 set up to track remote branch master from upstream.

  • Note: Although this makes it easier to pull from upstream/master, it doesn't change anything with regards to pushing. git push fails because you don't have permission to push to upstream/master.

     $ git push
 error: The requested URL returned error: 403 while accessing https://github.com/CleverRaven/Cataclysm-DDA.git
 fatal: HTTP request failed
 $ git push origin
 ....
 To https://github.com/YOUR_USERNAME/Cataclysm-DDA.git
 xxxx..xxxx  new_feature -> new_feature

PR Tags

If you file a PR but you're still working on it, please add a [WIP] before the title text. This will tell the reviewers that you still intend to add more to the PR and we don't need to review it yet. When it's ready to be reviewed by a merger just edit the title text to remove the [WIP].

If you are also looking for suggestions then mark it with [CR] - "comments requested". You can use both [WIP] and [CR] to indicated that you need opinion/code review/suggestions to continue working (e.g. "[WIP] [CR] Super awesome big feature"). Feel free to remove [CR] when you feel you got enough information to proceed.

This can help speed up our review process by allowing us to only review the things that are ready for it, and will prevent anything that isn't completely ready from being merged in.

One more thing: when marking your PR as closing, fixing, or resolving issues, please include "XXXX #???" somewhere in the description, where XXX is on this list: close closes closed fix fixes fixed resolve resolves resolved And ??? is the number. This automatically closes the issue when the PR is pulled in, and allows mergers to work slightly faster. To close multiple issues format it as "XXXX #???, XXXX#???".

Frequently Asked Questions

####Why does git pull --ff-only result in an error?

If git pull --ff-only shows an error, it means that you've committed directly to your local master branch. To fix this, we create a new branch with these commits, find the point at which we diverged from upstream/master, and then reset master to that point.

$ git pull --ff-only upstream master
From https://github.com/CleverRaven/Cataclysm-DDA
 * branch            master     -> FETCH_HEAD
fatal: Not possible to fast-forward, aborting.
$ git branch new_branch master          # mark the current commit with a tmp branch
$ git merge-base master upstream/master
cc31d0... # the last commit before we committed directly to master
$ git reset --hard cc31d0....
HEAD is now at cc31d0... ...

Now that master has been cleaned up, we can easily pull from upstream/master, and then continue working on new_branch.

$ git pull --ff-only upstream master
# gets changes from the "upstream" remote for the matching branch, in this case "master"
$ git checkout new_branch