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:
Before you submit your Pull Request (PR) consider the following guidelines:
-
Search GitHub for an open or closed PR that relates to your submission before creating a new one.
-
Be sure that an issue describes the problem you're fixing (If not, please create an issue on our board).
-
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
-
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. -
Push your branch to GitHub:
git push origin my-fix-branch
-
In GitHub, send a pull request to our
develop
branch, orEnhancePoEApp:develop
if you have forked the repo.
TODO: We will update this as needed.
- Check spelling on all code submitted for review.
- Avoid adding new 3rd party dependencies (NuGet packages) unless absolutely necessary. (Chat with us on #code-discussion)
- If changes are proposed to the back-end infra, any supplemental documentation would be much appreciated.