Skip to content

Latest commit

History

History
55 lines (38 loc) 路 1.93 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) 路 1.93 KB

Contributing to the Chaos Recipe Enhancer (EnhancePoEApp) Repository

We appreciate any help in the project we can get. Before doing so, however, we have some guidelines we'd like for you to follow:

Submission Guidelines

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission before creating a new one.

  2. Be sure that an issue describes the problem you're fixing (If not, please create an issue on our board).

  3. Make your changes in a new git branch:

    For new features and enhancements:

    git checkout -b feature/{{ your github username }}/{{ very short description of feature }} develop

    For new bug fixes:

    git checkout -b bugfix/{{ your github username }}/{{ very short description of bugfix }} develop

    Example:

    git checkout -b bugfix/himariolopez/crucible-stash-items-not-loading
  4. Commit your changes using a descriptive commit message.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  5. Push your branch to GitHub:

    git push origin my-fix-branch
  6. In GitHub, send a pull request to our develop branch, or EnhancePoEApp:develop if you have forked the repo.

Coding Guidelines

TODO: We will update this as needed.

  1. Check spelling on all code submitted for review.
  2. Avoid adding new 3rd party dependencies (NuGet packages) unless absolutely necessary. (Chat with us on #code-discussion)
  3. If changes are proposed to the back-end infra, any supplemental documentation would be much appreciated.