|
| 1 | +# Contributing |
| 2 | + |
| 3 | +When contributing to this repository, please first discuss the change you wish to make via issue, |
| 4 | +email, or any other method with the owners of this repository before making a change. |
| 5 | + |
| 6 | +Please note we have a code of conduct, please follow it in all your interactions with the project. |
| 7 | + |
| 8 | +## Before creating a Merge Request |
| 9 | + |
| 10 | +1. Make sure you have the most up to date code |
| 11 | + |
| 12 | +If you haven't done so, please set upstream as described in [Gitlab Documentation](https://docs.gitlab.com/ce/workflow/forking_workflow.html) |
| 13 | + |
| 14 | +Make sure you do not have any uncommitted changes and rebase master with latest changes from upstream: |
| 15 | + |
| 16 | +``` |
| 17 | +git fetch upstream |
| 18 | +git checkout master |
| 19 | +git rebase upstream/master |
| 20 | +``` |
| 21 | + |
| 22 | +Now you should rebase your branch with master, to receive the upstream changes |
| 23 | + |
| 24 | +``` |
| 25 | +git checkout branch |
| 26 | +git rebase master |
| 27 | +``` |
| 28 | + |
| 29 | + |
| 30 | +In both cases, you can have conflicts: |
| 31 | + |
| 32 | +``` |
| 33 | +error: could not apply fa39187... something to add to patch A |
| 34 | +
|
| 35 | +When you have resolved this problem, run "git rebase --continue". |
| 36 | +If you prefer to skip this patch, run "git rebase --skip" instead. |
| 37 | +To check out the original branch and stop rebasing, run "git rebase --abort". |
| 38 | +Could not apply fa39187f3c3dfd2ab5faa38ac01cf3de7ce2e841... Change fake file |
| 39 | +``` |
| 40 | + |
| 41 | +Here, Git is telling you which commit is causing the conflict (fa39187). You're given three choices: |
| 42 | + |
| 43 | +* You can run `git rebase --abort` to completely undo the rebase. Git will return you to your branch's state as it was before git rebase was called. |
| 44 | +* You can run `git rebase --skip` to completely skip the commit. That means that none of the changes introduced by the problematic commit will be included. It is very rare that you would choose this option. |
| 45 | +* You can fix the conflict. |
| 46 | + |
| 47 | +To fix the conflict, you can follow [the standard procedures for resolving merge conflicts from the command line](https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line). When you're finished, you'll need to call `git rebase --continue` in order for Git to continue processing the rest of the rebase. |
| 48 | +## Merge Request Process |
| 49 | + |
| 50 | +1. Ensure any install or build dependencies are removed before the end of the layer when doing a |
| 51 | + build. |
| 52 | +2. Update the [README.md](./README.md) with details of changes to the interface, this includes new environment |
| 53 | + variables, exposed ports, useful file locations and container parameters. |
| 54 | +3. Increase the version numbers in any examples files and the [README.md](./README.md) to the new version that this |
| 55 | + Merge Request would represent. |
| 56 | +4. You may merge the Merge Request in once you have the sign-off of two other developers, or if you |
| 57 | + do not have permission to do that, you may request the second reviewer to merge it for you. |
| 58 | + |
| 59 | +## Code of Conduct |
| 60 | + |
| 61 | +### Our Pledge |
| 62 | + |
| 63 | +In the interest of fostering an open and welcoming environment, we as |
| 64 | +contributors and maintainers pledge to making participation in our project and |
| 65 | +our community a harassment-free experience for everyone, regardless of age, body |
| 66 | +size, disability, ethnicity, gender identity and expression, level of experience, |
| 67 | +nationality, personal appearance, race, religion, or sexual identity and |
| 68 | +orientation. |
| 69 | + |
| 70 | +### Our Standards |
| 71 | + |
| 72 | +Examples of behavior that contributes to creating a positive environment |
| 73 | +include: |
| 74 | + |
| 75 | +* Using welcoming and inclusive language |
| 76 | +* Being respectful of differing viewpoints and experiences |
| 77 | +* Gracefully accepting constructive criticism |
| 78 | +* Focusing on what is best for the community |
| 79 | +* Showing empathy towards other community members |
| 80 | + |
| 81 | +Examples of unacceptable behavior by participants include: |
| 82 | + |
| 83 | +* The use of sexualized language or imagery and unwelcome sexual attention or |
| 84 | +advances |
| 85 | +* Trolling, insulting/derogatory comments, and personal or political attacks |
| 86 | +* Public or private harassment |
| 87 | +* Publishing others' private information, such as a physical or electronic |
| 88 | + address, without explicit permission |
| 89 | +* Other conduct which could reasonably be considered inappropriate in a |
| 90 | + professional setting |
| 91 | + |
| 92 | +### Our Responsibilities |
| 93 | + |
| 94 | +Project maintainers are responsible for clarifying the standards of acceptable |
| 95 | +behavior and are expected to take appropriate and fair corrective action in |
| 96 | +response to any instances of unacceptable behavior. |
| 97 | + |
| 98 | +Project maintainers have the right and responsibility to remove, edit, or |
| 99 | +reject comments, commits, code, wiki edits, issues, and other contributions |
| 100 | +that are not aligned to this Code of Conduct, or to ban temporarily or |
| 101 | +permanently any contributor for other behaviors that they deem inappropriate, |
| 102 | +threatening, offensive, or harmful. |
| 103 | + |
| 104 | +### Scope |
| 105 | + |
| 106 | +This Code of Conduct applies both within project spaces and in public spaces |
| 107 | +when an individual is representing the project or its community. Examples of |
| 108 | +representing a project or community include using an official project e-mail |
| 109 | +address, posting via an official social media account, or acting as an appointed |
| 110 | +representative at an online or offline event. Representation of a project may be |
| 111 | +further defined and clarified by project maintainers. |
| 112 | + |
| 113 | +### Enforcement |
| 114 | + |
| 115 | +Instances of abusive, harassing, or otherwise unacceptable behavior may be |
| 116 | +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All |
| 117 | +complaints will be reviewed and investigated and will result in a response that |
| 118 | +is deemed necessary and appropriate to the circumstances. The project team is |
| 119 | +obligated to maintain confidentiality with regard to the reporter of an incident. |
| 120 | +Further details of specific enforcement policies may be posted separately. |
| 121 | + |
| 122 | +Project maintainers who do not follow or enforce the Code of Conduct in good |
| 123 | +faith may face temporary or permanent repercussions as determined by other |
| 124 | +members of the project's leadership. |
| 125 | + |
| 126 | +### Attribution |
| 127 | + |
| 128 | +* This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, |
| 129 | +available at [http://contributor-covenant.org/version/1/4][version] |
| 130 | +* The contribution guide is adapted from [Good-CONTRIBUTING](https://gist.github.com/PurpleBooth/b24679402957c63ec426) |
| 131 | + |
| 132 | +[homepage]: http://contributor-covenant.org |
| 133 | +[version]: http://contributor-covenant.org/version/1/4/ |
0 commit comments