Oluwasegun-AA/md-generator

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
### Contributing
When contributing to this repository, Kindly first discuss the change you wish to make via issue, or any other method with the owners of this repository before making a change.

Also, kindly note read through the code of conduct as described in the `code_of_conduct.md` file, as it better guides your interactions with the project.

### Pull Request Process
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Ensure you follow strictly the pre-populated `pull_Request template`.
- Update the `README.md` with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the `README.md` to the new version that this Pull Request would represent. The versioning scheme we use is  semantic versioning ( `SemVer` ).
- You may merge the Pull Request in once you have the sign-off of three other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

### 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: