Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 5.93 KB

CONTRIBUTING.md

File metadata and controls

101 lines (69 loc) · 5.93 KB
Raw

Contributing

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. 🎉

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

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 better to search for existing 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.

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

  • Open an Issue.
  • Provide as much context as you can about what you're running into.

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

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.

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.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible binary to your OS/Platform (Make sure that you have read the documentation.
  • 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.
  • Collect information about the bug:
    • Stack trace
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Golang version, runtime environment or what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

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

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Azion CLI, 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.
  • 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.
  • If your enhancement is nontrivial, please open an Issue to discuss the idea and implementation strategy before submitting a PR.

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 and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most Azion CLI 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. Fork the repo
  2. Clone your forked repo
  3. Commit the changes you’ve developed on your fork
  4. If everything looks good, create a pull request on the base repo with your changes.

We use semantic commit

To ensure that all commits follow the semantic commit pattern, we need to configure Git to use our custom hooks. Run the following command to configure the hooks directory:

git config core.hooksPath hooks

# To check that the hooks configuration is correct, you can do an empty commit
# git commit --allow-empty -m "Hook commit-msg"