CONTRIBUTING.md

   1 <!--
   2 Licensed under the Apache License, Version 2.0 (the "License");
   3 you may not use this file except in compliance with the License.
   4 You may obtain a copy of the License at
   5
   6    http://www.apache.org/licenses/LICENSE-2.0
   7
   8 Unless required by applicable law or agreed to in writing, software
   9 distributed under the License is distributed on an "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  11 implied.
  12 See the License for the specific language governing permissions and
  13 limitations under the License
  14 -->
  15 # Contributing
  16
  17 When contributing to this repository, please first discuss the change you wish to make via issue,
  18 email, or any other method with the owners of this repository (Module Development Leads - MDL)
  19 before making a change.
  20
  21 Please note we have a code of conduct, please follow it in all your interactions with the project.
  22
  23 ## Process for Committing changes and Pushing them to Gerrit
  24
  25 1. Ensure that you have properly configured your git environment, and you have read these
  26    guidelines (<https://osm.etsi.org/docs/developer-guide/>). Please remind to configure your
  27    username and user email that you use in your ETSI On Line (EOL) account). Please remind to
  28    install the Gerrit commit-msg hook for the cloned repository in order to automatically insert a
  29    Change-Id tag in commit messages.
  30 2. Ensure that you work in the right branch for the change. The brach will be typically `master`,
  31    but in some circumstances, the MDL could ask you to use a release branch (e.g. `v7.0`) or a
  32    feature branch (e.g. `featureXXXX`).
  33 3. Ensure that any new added file includes the Apache2 license header. In case you don't know how
  34    to add it, look at other files in the repo and follow the same practice, or ask to the MDL.
  35 4. Ensure any new build dependencies are included in the Dockerfile.
  36 5. If it makes sense, update the README.md with details of changes to the module.
  37 6. Increase the version numbers in any examples files and the README.md to the new version that this
  38    commit would represent. The versioning scheme we use is [SemVer](http://semver.org/).
  39 7. When creating the commit, ensure that the commit is properly signed and includes the change-id.
  40 8. Before pushing to gerrit, it is strongly recommended that you rebase your work
  41    (`git pull --rebase`), so that your work is on top of the current remote branch.
  42 9. Push to the right gerrit branch `HEAD:refs/for/BRANCH`.
  43 10. Look at the Gerrit entry and check for Jenkins validation and MDL review. In case of comments
  44     from MDL or Jenkins fails, amend your commit following the guidelines and push again to gerrit.
  45
  46 ## Code of Conduct
  47
  48 ### Our Pledge
  49
  50 In the interest of fostering an open and welcoming environment, we as
  51 contributors and maintainers pledge to making participation in our project and
  52 our community a harassment-free experience for everyone, regardless of age, body
  53 size, disability, ethnicity, gender identity and expression, level of experience,
  54 nationality, personal appearance, race, religion, or sexual identity and
  55 orientation.
  56
  57 ### Our Standards
  58
  59 Examples of behavior that contributes to creating a positive environment
  60 include:
  61
  62 * Using welcoming and inclusive language
  63 * Being respectful of differing viewpoints and experiences
  64 * Gracefully accepting constructive criticism
  65 * Focusing on what is best for the community
  66 * Showing empathy towards other community members
  67
  68 Examples of unacceptable behavior by participants include:
  69
  70 * The use of sexualized language or imagery and unwelcome sexual attention or
  71 advances
  72 * Trolling, insulting/derogatory comments, and personal or political attacks
  73 * Public or private harassment
  74 * Publishing others' private information, such as a physical or electronic
  75   address, without explicit permission
  76 * Other conduct which could reasonably be considered inappropriate in a
  77   professional setting
  78
  79 ### Our Responsibilities
  80
  81 Project maintainers are responsible for clarifying the standards of acceptable
  82 behavior and are expected to take appropriate and fair corrective action in
  83 response to any instances of unacceptable behavior.
  84
  85 Project maintainers have the right and responsibility to remove, edit, or
  86 reject comments, commits, code, wiki edits, issues, and other contributions
  87 that are not aligned to this Code of Conduct, or to ban temporarily or
  88 permanently any contributor for other behaviors that they deem inappropriate,
  89 threatening, offensive, or harmful.
  90
  91 ### Scope
  92
  93 This Code of Conduct applies both within project spaces and in public spaces
  94 when an individual is representing the project or its community. Examples of
  95 representing a project or community include using an official project e-mail
  96 address, posting via an official social media account, or acting as an appointed
  97 representative at an online or offline event. Representation of a project may be
  98 further defined and clarified by project maintainers.
  99
 100 ### Enforcement
 101
 102 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 103 reported by contacting the project team at <OSM_MDL@LIST.ETSI.ORG>. All
 104 complaints will be reviewed and investigated and will result in a response that
 105 is deemed necessary and appropriate to the circumstances. The project team is
 106 obligated to maintain confidentiality with regard to the reporter of an incident.
 107 Further details of specific enforcement policies may be posted separately.
 108
 109 Project maintainers who do not follow or enforce the Code of Conduct in good
 110 faith may face temporary or permanent repercussions as determined by other
 111 members of the project's leadership.
 112
 113 ### Attribution
 114
 115 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
 116 available at [http://contributor-covenant.org/version/1/4][version]
 117
 118 [homepage]: http://contributor-covenant.org
 119 [version]: http://contributor-covenant.org/version/1/4/