This project has a Code of Conduct. Participating in this project requires you to abide by its terms. Please review our Contributor License Agreement ("CLA") prior to submitting changes to the project. Please direct any questions to opensource@optum.com.
Take a look in the issues. Maybe your question is already answered.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Issue Tracker. Even better you can submit a Pull Request with a fix for the issue you filed.
You can request a new feature by submitting an issue to our GitHub Issue Tracker. If you would like to implement a new feature then first create a new issue and discuss it with one of our project maintainers.
Before you submit your issue search the archive, maybe your question was already answered.
If your issue appears to be a bug, and hasn’t been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
-
Overview of the Issue - if an error is being thrown a stack trace helps
-
Motivation for or Use Case - explain why this is a bug for you
-
Giraffle Version - is it a named version or from our dev branch
-
Operating System - Mac, windows? details help
-
Suggest a Fix - if you can’t fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
Please read this guide and make sure you agree with our Contributor License Agreement ("CLA").
-
Write good commit messages
-
Reference your issues within your commits.
Fork the project on GitHub and clone your copy.
$ git clone git@github.com:username/giraffle.git
$ cd giraffle
$ git remote add upstream git://github.com/optum/giraffle.gitAll bug fixes and new features go into the dev branch.
We ask that you open an issue in the issue tracker and get agreement from at least one of the project maintainers before you start coding.
Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with that of a project maintainer.
Okay, so you have decided to fix something. Create a feature branch and start hacking:
$ git checkout -b my-feature-branch -t origin/devWe use .editorconfig to configure our editors for
proper code formatting. If you don’t use a tool that supports editorconfig be
sure to configure your editor to use the settings equivalent to our
.editorconfig file.
Make sure git knows your name and email address:
$ git config user.name "J. Random User"
$ git config user.email "j.random.user@example.com"|
ℹ️
|
The name and email address must be valid as we cannot accept anonymous contributions. |
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:
-
Always try to answer the question, "If this commit is merged into master it will…"
-
The first line should be 50 characters or less and contain a short description of the change including the Issue number prefixed by a hash (#).
-
Keep the second line blank.
-
Wrap all other lines at 72 columns.
A good commit log looks like this:
feature #123: Add interactive shell experience Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue being fixed, etc etc. The body of the commit message can be several paragraphs, and please do proper word-wrap and keep columns shorter than about 72 characters or so. That way `git log` will show things nicely even when it is indented.
The header line should be meaningful; it is what other people see when they
run git shortlog or git log --oneline.
Use git rebase (not git merge) to sync your work from time to time.
$ git fetch upstream
$ git rebase upstream/devWe are working hard to improve Giraffle’s testing. Currently our testing is focused on integration testing. Please ensure your code doesn’t break existing functionality. Additionally, please ensure any new features you add have proper tests add as well.
$ ./gradlew integrationTestMake sure that all tests pass. Please, do not submit patches that fail.
Go to https://github.com/{username}/giraffle and select your feature branch.
Click the Pull Request button and fill out the form.
Pull requests are usually reviewed within a few days. If you get comments that need to be to addressed, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits to existing pull requests. The first time you open a pull request in this repository, you will see a comment on your PR with a link that will allow you to sign our Contributor License Agreement (CLA) if necessary.
|
ℹ️
|
The link will take you to a page that allows you to view our CLA. You will need to click the Sign in with GitHub to agree button and authorize the cla-assistant application to access the email addresses associated with your GitHub account. Agreeing to the CLA is also considered to be an attestation that you either wrote or have the rights to contribute the code. All committers to the PR branch will be required to sign the CLA, but you will only need to sign once. This CLA applies to all repositories in the Optum org.
|
That’s it! Thank you for your contribution!
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete my-feature-branch-
Check out the dev branch:
git checkout dev -f-
Delete the local branch:
git branch -D my-feature-branch-
Update your dev with the latest upstream version:
git pull --ff upstream dev