Contributions to the T4Utils 2 library is strongly encouraged from TerminalFour community members to enhance and optimize this library. Before opening an issue or creating a pull request, please read through this documentation.
When making an issue, please be as detailed as possible on the subject of your submission. If we cannot fully understand the issue you've submitted, we will request further clarification. If clarification cannot be provided within 5 days, the issue will be closed and we request you open a new issue.
As to make this project more accessible to other developers within the TerminalFour community, we've removed JSHint linting from the Gulp build system. This means that to ensure the library stays with a consistent and error/warning free codebase, we request all contributors to utilize a JSHint linter in their IDE of choice.
If a pull request is made with Javascript errors/warnings, we will immediately decline the merge and request you make the necessary fixes utilizing a JSHint linter.
These instructions were inspired by Bootstrap's pull request information within their contribution guidelines:
- Fork the repo, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/t4utils2.git
# Navigate to the newly cloned directory
cd t4utils2
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/virginiacommonwealthuniversity/t4utils2.git- If you cloned a while ago, get the latest changes from upstream:
git checkout master
git pull upstream master- Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>- Ensure your commits are contextual and informative as to what changes/additions/deletions have been made
- Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream master- Open a Pull Request with a clear title and description against the master branch.