Contributions from the community are essential in keeping uPortal (any Open Source project really) strong and successful. While we try to keep requirements for contributing to a minimum, there are a few guidelines we ask that you mind.
If you are just getting started with Git, GitHub and/or contributing to uPortal via GitHub there are a few pre-requisite steps.
- Make sure you have a Jasig Jira account
- Make sure you have a GitHub account
- Fork the uPortal repository. As discussed in
the linked page, this also includes:
- Set up your local git install
- Clone your fork
Create a "topic" branch on which you will work. The convention is to name the branch
using the JIRA issue key. If there is not already a Jira issue covering the work you
want to do, create one. Assuming you will be working from the master branch and working
on the Jira UP-123 : git checkout -b UP-123 master
For a more in-depth description of the git workflow check out the uPortal Git Workflow
Do yo thang!
- Make commits of logical units.
- Be sure to use the JIRA issue key in the commit message. This is how Jira will pick up the related commits and display them on the Jira issue.
- Make sure you have added the necessary tests for your changes.
- Run all the tests to assure nothing else was accidentally broken.
Prior to commiting, if you want to pull in the latest upstream changes (highly appreciated btw), please use rebasing rather than merging. Merging creates "merge commits" that really muck up the project timeline.
- Sign the Contributor License Agreement.
- Push your changes to a topic branch in your fork of the repository.
- Initiate a pull request
- Update the Jira issue, adding a comment inclusing a link to the created pull request