Skip to content

Latest commit

 

History

History
119 lines (81 loc) · 4.71 KB

CONTRIBUTING.md

File metadata and controls

119 lines (81 loc) · 4.71 KB
Raw

Contributing

When contributing to gyselroth/php-helper, please first discuss the change you wish to make via an issue within the github repository, before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

When developing bugfixes and new features:

  • For every feature, same as bugfix, a related issue should be filed. See also: Commit style
  • Always develop on branches, never on master.
  • Add all changes under the upcoming version (reflected also in the name of the used branch) into CHANGELOG.md
  • Ensure to update and extend documentation (minimum: README.md) w/ relevant additions and changes

Commit style

Commits should be in the following format:

$ git commit -m"resolves #12345: implement easter egg
>
>More details about the commit."

Pull Request Process

Pull requests concerning improvements and additions to gyselroth/php-helper are welcome.

  1. The source code of gyselroth/php-helper follows the PSR-2 Coding Style Guide,
  2. Please discuss your goals before adding any third party dependencies
  3. Update the README.md with any helper-subjects added in case of additions The versioning scheme we use is SemVer.
  4. Add a description of improvements, additions, changes, bugfixes, etc. included within the pull request to the CHANGELOG.md
  5. In case of version changes- suggest the version number that this Pull Request would represent along the description of changes within CHANGELOG.md

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective ActionRunner in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4