The following is a set of guidelines for contributing to RESO WebAPI Client PHP. When contributing to this repository, please first discuss the change you wish to make via issue instance in the GitHub repository before making a change. Developers wishing more information on how to contribute please visit RESO Developers FAQ.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- **Check the current issues list in the repository to avoid multiple issue reporting.
- **Gather the essential information about the issue and proceed with the submission of a new issue / bug report.
Bugs are tracked as GitHub issues. Follow the issue template and fill the issue inside the GitHub repository’s Issue section.
- For public / Non-RESO developers. Fork the “develop” branch of the repository and apply the suggested code changes to your forked repository. Follow the below mentioned guidelines and fill in the Pull Request template and submit the pull request;
- For RESO Developers. Create a separate fixes/ or features/ branch out of the current develop branch and apply the changes;
General Pull Request guidelines:
- Follow and fill in the Pull Request template
- Include screenshots, debug logs, error messages or whatever additional material that would help to understand the changes in the Pull Request;
- Follow the <Specific Programming Guidelines, if applicable> guidelines and style guides;
- Document new code based on the documentation style guide ();
- Define / adjust code tests where applicable. The test should cover each current and / or newly established;
- Repository maintainers and / or delegated developers would review the changes in the Pull Request and approve, reject or return for additional changes.
- After acceptance the CHANGELOG.md must be adjusted by the maintainers to add-in the merged pull request. Appropriately, on release, the version references should be updated. Please, refer to the CHANGELOG.md file management guidelines in this document.
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.
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
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action 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.
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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@reso.org . 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.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4