Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 1.98 KB

Thank you for contributing!

Bug report or new feature proposal

Create a new issue from here.

Pull request

  1. Create a new issue.
  2. Fork this repository and clone the forked one.
  3. Set up upstream branch. git remote add upstream https:://github.com/YOUR_ACCOUNT/ElonaFoobar.
  4. Update local develop. git checkout develop && git pull upstream develop.
  5. Create your working branch from develop. Naming conventions are as follows:
  • Prepend feature/ to the short summary of your changes. For example,
    • feature/import-XXX-from-omake
  1. Work and commit your changes. Small commits are prefered.
  2. Update local develop again.
  3. Rebase. git checkout YOUR_WORKING_BRANCH && git rebase develop.
  4. Push to your remote branch. git push origin YOUR_WORKING_BRANCH.
  5. Create a new pull request.
  6. Your pull request is reviewed and fix problems if needed.
  7. Your pull request is merged.

If your changes are big or you need help, you can send a pull request with prefix [WIP]. Pull requests marked as "work in progress" are not merged.

In all commits, the C++ source code should be formatted by clang-format.

Lua API features

  1. Create a binding in lua_api.cpp inside the appropriate namespace.
  • Add overrides for functions taking position_t so two ints can be passed instead.
  1. Set the binding on the correct table in lua::init().
  2. Update .luacheckrc with the new table value.
  3. Add LDoc documentation in doc/api.
  4. Add tests inside tests/lua_api.cpp.
  5. Provide a playtest script demonstrating the API in the pull request.

Branching rules

We use Git flow. See http://nvie.com/posts/a-successful-git-branching-model/ for details, and we recommend this tool: https://github.com/nvie/gitflow.

Code style

See CODE_STYLE.md.

Commit messages

Follow this format.

Fix aaa bbb ccc
  • Neither fix, Fixed nor fixing.
  • No period.
  • Other appropriate verbs are allowed.