github.com/hellofresh/janus@v0.0.0-20230925145208-ce8de8183c67/CONTRIBUTING.md (about)

     1  # Contributing to Janus
     2  
     3  :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
     4  
     5  The following is a set of guidelines for contributing to Janus and its packages, 
     6  which are hosted in the [HelloFresh Organization](https://github.com/hellofresh) on GitHub.
     7  These are just guidelines, not rules. Use your best judgment, and feel free to propose changes 
     8  to this document in a pull request.
     9  
    10  ## Code of Conduct
    11  
    12  This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
    13  By participating, you are expected to uphold this code.
    14  Please report unacceptable behavior to [engineering@hellofresh.com](mailto:engineering@hellofresh.com).
    15  
    16  We accept contributions via Pull Requests on [Github](https://github.com/hellofresh/janus).
    17  
    18  ## How Can I Contribute?
    19  
    20  ### Reporting Bugs
    21  
    22  This section guides you through submitting a bug report for Janus. Following these guidelines helps maintainers 
    23  and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related 
    24  reports :mag_right:.
    25  
    26  Before creating bug reports, please check if the bug was already reported before as you might find out that you don't 
    27  need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). 
    28  
    29  #### How Do I Submit A (Good) Bug Report?
    30  
    31  Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on provide the following information.
    32  
    33  Explain the problem and include additional details to help maintainers reproduce the problem:
    34  
    35  * **Use a clear and descriptive title** for the issue to identify the problem.
    36  * **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started Janus, 
    37  e.g. which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it**.
    38  * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. 
    39  If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
    40  * **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
    41  * **Explain which behavior you expected to see instead and why.**
    42  
    43  Include details about your configuration and environment:
    44  
    45  * **Which version of Janus are you using?**
    46  * **What's the name and version of the OS you're using**?
    47  
    48  ### Your First Code Contribution
    49  
    50  Unsure where to begin contributing to Janus? You can start by looking through these `beginner` and `help-wanted` issues:
    51  
    52  * [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
    53  * [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
    54  
    55  Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
    56  
    57  ### Pull Requests
    58  
    59  * Include screenshots and animated GIFs in your pull request whenever possible.
    60  * Follow the [Go](https://github.com/golang/go/wiki/CodeReviewComments) styleguides.
    61  * Include thoughtfully-worded, well-structured tests.
    62  * Document new code
    63  * End files with a newline.
    64  
    65  
    66  Happy Coding from the HelloFresh Engineering team!