Skip to content

Latest commit

 

History

History
140 lines (90 loc) · 5.84 KB

CONTRIBUTING.md

File metadata and controls

140 lines (90 loc) · 5.84 KB
Raw

Contributing to Forest Terraform

We'd love for you to contribute to our source code and to make the Forest even better than it is today! Here are the guidelines we'd like you to follow:

Got a Question or Problem?

If you have questions about how to use the Forest, please direct these to the Slack group / philips-software.

Slack

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our Github Repository. Even better you can submit a Pull Request with a fix.

Please see the Submission Guidelines below.

Want a Feature?

You can request a new feature by submitting an issue to our Github Repository. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first on our Slack group so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Changes can be crafted and submitted to the Github Repository as a Pull Request.

Want a Doc Fix?

If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Create a new issue (or comment on a related existing one) to let others know what you're working on.

For large fixes, please build and test the documentation before submitting the MR to be sure you haven't accidentally introduced any layout or formatting issues. You should also make sure that your commit message starts with "docs" and follows the Commit Message Guidelines outlined below.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • Forest Version(s) - is it a regression?
  • Reproduce the Error - try to describe how to reproduce the error
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

If you get help, help others. Good karma rulez!

Submitting a Merge Request

Before you submit your merge request consider the following guidelines:

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch develop

  • Create your patch, including appropriate test cases.

  • Install Terraform. We lock the version with tvenv, check required_version in versions.tf for the current development version of the module.

  • Install pre-commit hooks. The hooks runs some basic checks and update the docs. The commit will run the hooks, you can invoke the hooks manually pre-commit run --all-files as well.

  • Commit your changes using a descriptive commit message.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Build your changes locally to ensure all the tests pass:

  • Push your branch to Github:

    git push origin my-fix-branch

In Github, send a pull request to original develop branch: f.e. terraform-aws-github-runner:develop. If we suggest changes, then:

  • Make the required updates.
  • Re-run the test suite to ensure tests are still passing.
  • Commit your changes to your branch (e.g. my-fix-branch).
  • Push the changes to your Github repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git rebase develop -i
git push origin my-fix-branch -f

WARNING: Squashing or reverting commits and force-pushing thereafter may remove Github comments on code that were previously made by you or others in your commits. Avoid any form of rebasing unless necessary.

That's it! Thank you for your contribution!

After your merge request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on Github either through the Github web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the develop branch:

    git checkout develop -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your develop with the latest upstream version:

    git pull --ff upstream develop

Info

For more info, please reach out to the team on Slack group / philips-software in the #forest channel.

Use the badge to sign-up.

Slack