github.com/onflow/atree@v0.6.0/CONTRIBUTING.md (about)

     1  # Contributing to Atree
     2  
     3  The following is a set of guidelines for contributing to Atree.
     4  These are mostly guidelines, not rules.
     5  Use your best judgment, and feel free to propose changes to this document in a pull request.
     6  
     7  ## Table Of Contents
     8  
     9  [Getting Started](#project-overview)
    10  
    11  [How Can I Contribute?](#how-can-i-contribute)
    12  
    13  - [Reporting Bugs](#reporting-bugs)
    14  - [Suggesting Enhancements](#suggesting-enhancements)
    15  - [Your First Code Contribution](#your-first-code-contribution)
    16  - [Pull Requests](#pull-requests)
    17  
    18  [Styleguides](#styleguides)
    19  
    20  - [Git Commit Messages](#git-commit-messages)
    21  - [Go Styleguide](#go-styleguide)
    22  
    23  [Additional Notes](#additional-notes)
    24  
    25  ## How Can I Contribute?
    26  
    27  ### Reporting Bugs
    28  
    29  #### Before Submitting A Bug Report
    30  
    31  - **Search existing issues** to see if the problem has already been reported.
    32    If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
    33  
    34  #### How Do I Submit A (Good) Bug Report?
    35  
    36  Explain the problem and include additional details to help maintainers reproduce the problem:
    37  
    38  - **Use a clear and descriptive title** for the issue to identify the problem.
    39  - **Describe the exact steps which reproduce the problem** in as many details as possible.
    40    When listing steps, **don't just say what you did, but explain how you did it**.
    41  - **Provide specific examples to demonstrate the steps**.
    42    Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
    43    If you're providing snippets in the issue,
    44    use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
    45  - **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
    46  - **Explain which behavior you expected to see instead and why.**
    47  - **Include error messages and stack traces** which show the output / crash and clearly demonstrate the problem.
    48  
    49  Provide more context by answering these questions:
    50  
    51  - **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens
    52    and under which conditions it normally happens.
    53  
    54  Include details about your configuration and environment:
    55  
    56  - **What is the version of the Atree you're using**?
    57  - **What's the name and version of the Operating System you're using**?
    58  
    59  ### Suggesting Enhancements
    60  
    61  #### Before Submitting An Enhancement Suggestion
    62  
    63  - **Perform a cursory search** to see if the enhancement has already been suggested.
    64    If it has, add a comment to the existing issue instead of opening a new one.
    65  
    66  #### How Do I Submit A (Good) Enhancement Suggestion?
    67  
    68  Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/).
    69  Create an issue and provide the following information:
    70  
    71  - **Use a clear and descriptive title** for the issue to identify the suggestion.
    72  - **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
    73  - **Provide specific examples to demonstrate the steps**.
    74    Include copy/pasteable snippets which you use in those examples,
    75    as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
    76  - **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
    77  - **Explain why this enhancement would be useful** to Atree users.
    78  
    79  ### Your First Code Contribution
    80  
    81  Unsure where to begin contributing to Atree?
    82  You can start by looking through these "Good first issue" and "Help wanted" issues:
    83  
    84  - [Good first issues](https://github.com/onflow/atree/labels/good%20first%20issue):
    85    issues which should only require a few lines of code, and a test or two.
    86  - [Help wanted issues](https://github.com/onflow/atree/labels/help%20wanted):
    87    issues which should be a bit more involved than "Good first issue" issues.
    88  
    89  Both issue lists are sorted by total number of comments.
    90  While not perfect, number of comments is a reasonable proxy for impact a given change will have.
    91  
    92  ### Pull Requests
    93  
    94  The process described here has several goals:
    95  
    96  - Maintain code quality
    97  - Fix problems that are important to users
    98  - Engage the community in working toward the best possible Atree UX
    99  - Enable a sustainable system for the Atree's maintainers to review contributions
   100  
   101  Please follow the [styleguides](#styleguides) to have your contribution considered by the maintainers.
   102  Reviewer(s) may ask you to complete additional design work, tests,
   103  or other changes before your pull request can be ultimately accepted.
   104  
   105  ## Styleguides
   106  
   107  Before contributing, make sure to examine the project to get familiar with the patterns and style already being used.
   108  
   109  ### Git Commit Messages
   110  
   111  - Use the present tense ("Add feature" not "Added feature")
   112  - Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
   113  - Limit the first line to 72 characters or less
   114  - Reference issues and pull requests liberally after the first line
   115  
   116  ### Go Styleguide
   117  
   118  The majority of this project is written Go.
   119  
   120  We try to follow the coding guidelines from the Go community.
   121  
   122  - Code should be formatted using `gofmt`
   123  - Code should pass the linter: `make lint`
   124  - Code should follow the guidelines covered in
   125    [Effective Go](http://golang.org/doc/effective_go.html)
   126    and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
   127  - Code should be commented
   128  - Code should pass all tests: `make test`
   129  
   130  ## Additional Notes
   131  
   132  Thank you for your interest in contributing to Atree!