Contributions to PSDeploy would be quite welcome and helpful. This page describes some ideas and guidelines around contributing.
There are many ways to contribute, including:
- Open an issue for...
- A bug you find
- A feature you think would be valuable
- A question on using PSDeploy (you might not be the only one with the question)
- Edit the docs to...
- Improve or expand on existing docs
- Document a deployment type
- Write a 'How do I...' scenario
- Submit pull requests to...
- Improve or expand on the Readme.md or this Contributing.md
- Add or extend existing PSDeploy testing
- Add a new DeploymentType
- Provide bug fixes, new features, cleaner code, or other improvements
All of these require that you have a GitHub account.
- Submit an issue
- Use the search box and flip through open/closed issues to avoid duplication
- If the issue is for a bug fix, provide reproducible code. If you can't, and you think an issue is still warranted, provide your code, and related details on your environment
- Contribute to the docs
- Fork the repo
- Checkout and work in the master branch
- Organization is described in the mkdocs.yml file. If you add a file or section, mkdocs.yml needs to know
- mkdocs.yml points to markdown files in the docs folder
- Images are stored and accessible from docs/images
- Commit changes
- Submit a pull request to the master branch
- Submit a pull request
- Fork the repo
- Checkout and work in the master branch
- Where possible, add Pester tests for your change
- Submit your pull request to the master branch
- General GitHub documentation
- GitHub forking documentation
- GitHub pull request documentation
- GitHub Flow guide
- GitHub's guide to contributing to open source projects
More to come, just getting this out there. Thanks to Brandon Olin for the starter .md.