Respin of PurpleBooth/README-Template.md and Contributing_Template.md in reStructuredText

Readme_Template.rst

Project Title

One paragraph of project description goes here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

$ use shell examples

Dev Install

A step by step series of examples that explain how to get a development environment installed and running.

Briefly explain what the step will be:

# a root shell example

And repeat...

$ run commands until finished

End with an example of getting some data out of the system or using it for a little demo.

Testing and Test Runners

Explain what test runners are required and how to run the tests for this system.

Test Environment and Test Data

Explain what the tests do and what the test data and/or test environment requirements are for running the tests.

$ run a test command

Standards and Coding Style

Explain what coding standards are applicable to the project and any tools used to check standards conformance as part of the test suite.

$ use another example

User Install / Deployment

Add additional notes about how to deploy this on a live system.

Built With or Depends On

• Python - language-specific tools and versions required by the project (at least version 3.5)
• nanoservice - dependency used for messaging
• nanomsg - library dependency for messaging protocols
• tox - dependency management and test driver

Related Projects

• Some other project that uses your project
• Another project with (more or less) the same functionality
• Alternate bloaty project with some useful extra features

Contributing

Please read CONTRIBUTING.rst for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Billie Thompson - Initial work - PurpleBooth
• Steve Arnold - Conversion to .rst and edits - FreePN

See also the list of contributors who participated in this project.

License

This project is licensed under the XXX License - see the LICENSE.txt file for details.

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

Such as:

• Thanks to Billie Thompson at PurpleBooth for the original markdown version
• The test focus inspired me to make an .rst version

Now available in multiple formats:

The original template file in markdown format and the modified template file in reStructuredText format.

Contributing_Template.rst

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

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

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README file with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any example files and the README to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
4. You may merge the Pull Request in once you have the sign-off of two 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:

• 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 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.

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 by contacting the project team at [INSERT EMAIL ADDRESS]. 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 homepage, version 1.4.