Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugins do tests work #11

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open

Plugins do tests work #11

wants to merge 19 commits into from

Conversation

bpowell
Copy link

@bpowell bpowell commented Sep 26, 2019

We prefer small, well tested pull requests.

Please refer to Contributing to Spinnaker.

When filling out a pull request, please consider the following:

  • Follow the commit message conventions found here.
  • Provide a descriptive summary for your changes.
  • If it fixes a bug or resolves a feature request, be sure to link to that issue.
  • Add inline code comments to changes that might not be obvious.
  • Squash your commits as you keep adding changes.
  • Add a comment to @spinnaker/reviewers for review if your issue has been outstanding for more than 3 days.

Note that we are unlikely to accept pull requests that add features without prior discussion. The best way to propose a feature is to open an issue first and discuss your ideas there before implementing them.


Helpful Tips

Add screenshots and annotations

Add a gif to show an action

GIFs are great to show an action, however they sometimes move too fast.
One way to improve them is to capture 3 pieces of content:

  • screenshot before an action
  • screenshot after the action
  • gif of the action
  • You can edit a gif using https://ezgif.com/

Put a border around a screenshot/gif

Add a border to help improve the readability.

<kbd>![](https://www.spinnaker.io/assets/images/spinnaker-logo-inline.svg)</kbd>

Add expandable sections

Add expandable sections to hide away large code blocks/images or reduce the motion of a gifs
const example = 'spinnaker spinnaker SPINNAKER';

@armory-jenkins
Copy link
Member

The title of the Pull Request needs to be changed.
Please follow https://www.spinnaker.io/community/contributing/submitting/#commit-message-conventions

@armory-jenkins
Copy link
Member

The title of the Pull Request needs to be changed.
Please follow https://www.spinnaker.io/community/contributing/submitting/#commit-message-conventions

@armory-jenkins
Copy link
Member

The title of the Pull Request needs to be changed.
Please follow https://www.spinnaker.io/community/contributing/submitting/#commit-message-conventions

@armory-jenkins
Copy link
Member

The title of the Pull Request needs to be changed.
Please follow https://www.spinnaker.io/community/contributing/submitting/#commit-message-conventions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants