Skip to content

Commit

Permalink
Adding contributing guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
BobJWalker committed May 29, 2020
1 parent dfd455f commit 607d3f6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Customer Success team plans on keeping this script up to date with the lates

## Pull Requests

We do accept Pull Requests on this repository.
We do accept Pull Requests on this repository. See [Contributing guidelines](docs/Contributing.md).

## Tested Octopus Deploy Versions

Expand Down
17 changes: 17 additions & 0 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing Guidelines

We are happy to accept pull requests for this repository. For a pull request to be approved the following guidelines must be followed:

- Have the CLA signed (you will be prompted to sign one when you create your PR)
- All new code follows the same structure as existing code.
- SpaceCloner - the entry script, it controls the order of which items are cloned.
- [Feature]Cloner - The cloning logic for a specific feature. Should have a entry function at the top that accepts `$sourceData`, `$destinationData`, and `$cloneScriptOptions` as parameters.
- OctopusDataAdapter - adapter providing low level access to the Octopus API.
- OctopusDataFactory - The factory which builds the source and destination data.
- OctopusRepository - Repository contains method to pull data by using the Octopus Data Adapter.
- Code standards
- Functions use [approved verbs](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands?view=powershell-7).
- Changes are well structured and easy to read.
- Plenty of logging for future debugging. No direct writing to the host, leverage the functions found in `Logging.ps1`.
- No direct access from a Cloner(s) to the OctopusDataAdapter. Everything should go through the OctopusRepository.
- Minimal duplicate code.

0 comments on commit 607d3f6

Please sign in to comment.