When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owner of this repository before making a change.
Please note we have a Code of Excellence, please follow it in all your interactions with the project.
| Project Owner | Robert Hameetman <rob@robhameetman.com> |
|---|
- Ensure all tests and builds are passing in updated packages.
- Click here to create a Pull Request
- All Pull Requests must be approved by the Project Owner. The Project Owner will review the changes in the Pull Request and may or may not provide feedback as necessary. If your Pull Request is denied, please implement any feedback provided and ensure any future Pull Requests comply with the Code of Excellence below.
- You may merge the Pull Request in once you have the sign-off of the Project Owner, or if you, do not have permission to do that, you may request the Project Owner to merge it for you.
Mr. Hameetman is a highly professional and dedicated Engineer. He takes seriously his obligation to the engineering and technology- focused communities he serves. To make sure he meets those obligations, Mr. Hameetman has established this Code of Excellence for contributors which is designed to articulate the ethical standards that serve as the cornerstone for the community’s activities – its principles, philosophies, mission and vision – and describe how they affect everyday behaviors and actions of its individuals.
The Code of Excellence is a program designed to bring out the best in the Engineers who contribute to this project and demonstrate to others that we:
- Perform the highest quality of Software Engineering work
- Lead by example to promote strict adherence to industry standards and best practices
- Execute tasks by putting craftsmanship first
The Code of Excellence is therefore a written policy of the culture of the ShadowUI community designed to instill a sense of pride and professionalism throughout the project. When adopted and implemented, the uniformity of this Code of Excellence shall demonstrate to prospective and current contributors that contributing to the ShadowUI project is synonymous with contributing excellence.
In the interest of fostering an open and welcoming culture of learning, we pledge to practice our profession with the highest level of integrity and competence. We pledge to be honest about our limitations, continuously seeking to improve our skills through life-long learning.
-
We shall exercise careful consideration of the correct balance between quality and productivity.
-
We shall not tremble in the face of a large refactor.
-
We shall strive to include meaningful tests and documentation in our Pull Requests whenever possible to protect the integrity of the project.
-
We shall make participation in our projects 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 culture of learning include:
- Writing organized, carefully-considered, well-documented code
- Writing meaninful tests
- Showing respect and empathy while providing constructive feedback in code review
Examples of unacceptable behavior by participants include:
- Writing sloppy, disorganized, overly verbose, or overly-engineered code
- Not including tests or including only basic tests
- Not including documentation or including only basic documentation
- Communicating with disrespect when discussing features or issues or when reviewing code
- Other conduct which could reasonably be considered inappropriate in a professional setting
Any Pull Requests which do not meet these standards may be rejected with or without notice at the Project Owner's discretion.
The Project Owner is responsible for clarifying the standards of acceptable behavior and is expected to take appropriate and fair corrective action in response to any instances of unprofessional conduct.
The Project Owner has 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 Excellence, or to ban temporarily or permanently any contributor for other behaviors that they deem as an inappropriate fit for the project for any reason.
The Project Owner is not obligated to provide feedback on any denied or accepted Pull Requests. The Project Owner has the right to deny, reject, or remove any contribution at any time for any reason, with or without notice to the contributor.
This Code of Excellence applies in all ShadowUI project spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official ShadowUI 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 the Project Owner.
Instances of abusive, harassing, or otherwise unprofessional conduct may be reported by emailing the Project Owner at rob@robhameetman.com.
All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The Project Owner is obligated to escalate abusive, harassing, or otherwise illegal conduct to law enforcement. Further details of specific enforcement policies may be posted separately.
Contributors who do not follow or enforce the Code of Excellence in good faith may face temporary or permanent adverse action as determined by the Project Owner.