Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 5.94 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 5.94 KB
Raw

Contributing

You are encouraged to contribute to the project by forking the project and submitting GitHub pull requests. This document describes guidelines to support you in submitting your contributions.

Intro

We welcome contributions to code, reporting defects,suggesting improvements and expanding documentation. All members of the community, including contributors, are expected to uphold the Code of Conduct.

Report an Issue

GitHub issues can be used to report suspected defects or submit feature requests.

When reporting a misbehaviour please make sure to provide:

  • the version of the Provider you were using (e.g. version number, or git commit);
  • the Operating system version you are using;
  • the expected VS obtained result;
  • the minimal steps needed to reproduce the issue

Find an Issue

Browse the GitHub issues section of this repo. Once you see an issue that you'd like to work on, please post a comment saying that you want to work on it: your comment will then be reviewed by a maintainer for issue assignment.

If you want to contribute but you don’t know where to start or can't find a suitable issue, you can have a look at the Discussions section.

Proposing a Feature

We recommend to go through the following steps when wishing to propose a feature.

  • Discuss your idea in Github discussions
  • Once there is general agreement that the feature is useful, create a GitHub issue to follow up. The issue should cover why the feature is needed, scope, use cases and any other considerations/limitations
  • If the scope requires, you'll be asked to submit a design, along with technical and implementation details
  • Once the major technical issues are resolved and agreed upon, post a note to summarise design decision and the general execution plan
  • Submit a PR with your proposed code change. Please make sure to cover documentation for your feature, including usage examples when possible

Please favour small PRs instead over giant scary PRs. We therefore suggest splitting large features into a set of progressive PRs that build on top of one another.

If you want to skip submitting an issue and instead prefer to just send a pull request with your proposed code change, we'll still consider it. However, please be aware that it may not be accepted: it is recommended to get agreement on the idea/design before spending time coding it. We know that, sometimes, sharing directly the code change can help focus discussions, so we leave you the option.

Developer Environment Setup

Please refer to the DEVELOPMENT.md.

How to make a Pull Request

For existing issues simply respond to the issue and express interest in working on it. This communication is important in order to prevent duplicated efforts. If your proposed fix or feature is not already covered by an issue you may consider opening one first.

To submit your proposed change:

  • fork this repository,
  • create a new branch for your changes called "dev/ISSUE_ID",
  • commit your code,
  • submit a pull request (PR)

Commit and PR Guidelines

A PR is more likely to be accepted if it has:

  • a well described PR body
  • a good commit message. We use conventional commits.
  • code that follows the conventions in old code
  • code that respects Go Code Review Comments
  • good enough demonstration of testing (see below)
  • all required checks green

Expected Level of Testing

Your change should include unit tests and regression tests to protect your feature or other features from breaking. Please make sure

  • that tests follow the conventions of existing ones;
  • for new features, to cover as many inputs/configurations as possible.

Naming

Please stick to the terraform provider naming conventions. To highlight a few:

  • Resource names should be nouns and start with biganimal_ e.g. biganimal_cluster.
  • Data source names should also be nouns. If the data sources return a list, the name can be plural e.g. biganimal_available_regions.
  • Attribute names within Terraform configuration blocks are conventionally named as all-lowercase with underscores.
  • If there is a need for exception to these naming conventions, the reason should be explicitly stated.
  • Data sources should be written in a file named data_source_<data_source_name>.go.
  • Resources should be written in a file named resource_<resource_name>.go.
  • Test files should be added as <filename>_test.go.
  • If you can organize the code into smaller packages, e.g. any helper or library code, you're encouraged to create new packages/directories.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. By signing off your commits, you guarantee that you wrote the patch or otherwise have the right to contribute the material by the rules of the DCO.

A signed commit includes the following line:

Signed-off-by: Jane Doe <[email protected]>

Please use your real name (sorry, no pseudonyms or anonymous contributions). If you set your user.name and user.email in your Git Config, you can sign your commit automatically with git commit -s.

You can find more information in the Github documentation for Signing commits.