Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
199 lines (140 loc) · 10.7 KB

CONTRIBUTING.md

File metadata and controls

199 lines (140 loc) · 10.7 KB

Contributing to terraform-provider-unifi

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it and share on different social media
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Discussions or issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open a Discussion.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions depending on what seems relevant.

We will then take care of the question as soon as possible.

I Want To Contribute

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version, especially importat in case of minor/patch versions that may contain fixes of your issue.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow, Reddit) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback), logs
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for terraform-provider-unifi, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots or screen recordings which help you demonstrate the steps or point out the part which the suggestion is related to. You can use LICEcap to record GIFs on macOS and Windows, and the built-in screen recorder in GNOME or SimpleScreenRecorder on Linux.
  • Explain why this enhancement would be useful to most terraform-provider-unifi users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

  1. Clone the repository

    git clone https://github.com/filipowm/terraform-provider-unifi.git

  2. Ensure you have the Go version installed as defined in go.mod file

    go version

    If you don't have the correct version, you can download it from the official Go website.

    If you have multiple versions of Go installed, you can use a tool like gvm

  3. Ensure you have the latest version of the project

    git pull

  4. Create a new branch

    git checkout -b my-new-feature

  5. Make your changes

  6. Run the tests

    go test ./...

  7. Lint your code using golangci-lint

    golangci-lint run --fix

  8. If tests are passing and code is linted, you can create a commit and then pull request following styleguides below.

Improving The Documentation

Any contribution to the documentation is highly appreciated. This includes both improvements to the existing documentation and adding new content. That's the most lightweight way to start contributing to the project.

Styleguides

Commit Messages

Please follow conventional commits standard for commit messages whenever possible. That's the best way to ensure that your commits are easy to understand and follow the project's versioning. If you are not familiar with the conventional commits, you can also use the following format:

<type>: <subject>

The <type> must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • chore: Changes to the build process, auxiliary tools, documentation, linting etc
  • refactor: A code change that neither fixes a bug nor adds a feature

The <subject> should be a short description of the change. Use the imperative, present tense.

Pull Requests

Please follow conventional commits

Join The Project Team

Create a discussion thread that you would like to join as a team member. New team members are always welcome. We are looking for people who are willing to contribute and help the project grow.