CONTRIBUTING.md

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