✨ Thanks for contributing to GoFormation! ✨
As a contributor, here are the guidelines we would like you to follow:
We also recommend that you read How to Contribute to Open Source.
Help us keep GoFormation open and inclusive. Please read and follow our Code of conduct.
Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
If you have never created a pull request before, welcome 🎉 😄. Here is a great tutorial on how to send one :)
Here is a summary of the steps to follow:
- Set up the workspace
- If you cloned a while ago, get the latest changes from upstream and update dependencies:
$ git checkout master
$ git pull upstream master- Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
$ git checkout -b <topic-branch-name>- Make your code changes, following the Coding rules
- Push your topic branch up to your fork:
$ git push origin <topic-branch-name>- Open a Pull Request with a clear title and description.
Tips:
- For ambitious tasks, open a Pull Request as soon as possible with the
[WIP]prefix in the title, in order to get feedback and help from the community. - Allow GoFormation maintainers to make changes to your Pull Request branch. This way, we can rebase it and make some minor changes if necessary.
To ensure consistency and quality throughout the source code, all code modifications must have:
- A test for every possible case introduced by your code change
- Valid commit message(s)
- Documentation for new features
- Updated documentation for modified features
If possible, make atomic commits, which means:
- a commit should contain exactly one self-contained functional change
- a functional change should be contained in exactly one commit
- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)
A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
The footer can contain a closing reference to an issue.
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
The type must be one of the following:
| Type | Description |
|---|---|
| build | Changes that affect the build system or external dependencies (go) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| docs | Documentation only changes |
| feat | A new feature |
| fix | A bug fix |
| perf | A code change that improves performance |
| refactor | A code change that neither fixes a bug nor adds a feature |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
`fix(pencil): stop graphite breaking when too much pressure applied`
`feat(pencil): add 'graphiteWidth' option`
Fix #42
perf(pencil): remove graphiteWidth option`
BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
Fork the project, clone your fork, configure the remotes and install the dependencies:
# Clone your fork of the repo into the current directory
$ git clone https://github.com/<your-github-user>/goformation
# Navigate to the newly cloned directory
$ cd goformation
# Assign the original repo to a remote called "upstream"
$ git remote add upstream https://github.com/awslabs/goformationBefore pushing your code changes make sure all tests pass.
$ go test ./...The GoFormation repository uses semantic-release to automatically generate CHANGELOG entries, and cut releases based on commit messages. It's important to follow the commit message guidelines so that this process continues to work.
To make things easier, you can use a tool like Commitizen CLI to help you craft your commit messages.
After staging your changes with git add, run npx git-cz to start the interactive commit message CLI.
While you work on features, you may want to regenerate the CloudFormation resources in GoFormation. To do this, run:
$ go generate
GoFormation Resource Generator
Downloading cloudformation specification from https://d1uauaxba7bl26.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json
Downloading sam specification from file://generate/sam-2016-10-31.json
Updated the following AWS CloudFormation resources:
- AWS::Serverless::Application
- AWS::SNS::Topic
Processed 1161 resources
You will see a summary of the resources that have been updated, and for more detailed changes you can just run git diff.
If your contributions to GoFormation include regenerating resources (e.g. you make a change to the resource template, which modifies all resources), please make sure to run the go generate in a different git commit. This will make the pull request review process a lot easier for everybody involved :)