github.com/timo-reymann/yal@v0.0.0-20240419173834-5d47db58f9d1/CONTRIBUTING.md (about)

     1  # Contributing to yal
     2  I love your input! I want to make contributing to this project as easy and transparent as possible, whether it's:
     3  
     4  - Reporting a bug
     5  - Discussing the current state of the code
     6  - Submitting a fix
     7  - Proposing new features
     8  - Becoming a maintainer
     9  
    10  ## I develop with Github
    11  I use github to host code, to track issues and feature requests, as well as accept pull requests.
    12  
    13  ## I Use [CircleCI](https://circleci.com/product/), So All Code Changes Happen Through Pull Requests
    14  Pull requests are the best way to propose changes to the codebase (I use [CircleCI](https://circleci.com/product/)). I actively welcome your pull requests:
    15  
    16  1. Fork the repo and create your branch from `main`.
    17  2. If you've added code that should be tested, add tests.
    18  3. If you've changed APIs, update the documentation.
    19  4. Ensure the tests pass.
    20  5. Make sure your code and commit lints.
    21  6. Issue that pull request!
    22  
    23  ## Any contributions you make will be under the GPL-3.0
    24  In short, when you submit code changes, your submissions are understood to be under the same [GPL-3.0](https://github.com/timo-reymann/yal/blob/main/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
    25  
    26  ## Report bugs using Github's issues
    27  I use GitHub issues to track public bugs. Report a bug by opening a new issue, it's that easy!
    28  
    29  ## Write bug reports with detail, background, and sample code
    30  
    31  **Great Bug Reports** tend to have:
    32  
    33  - A quick summary and/or background
    34  - Steps to reproduce
    35      - Be specific!
    36      - Give sample code if you can.
    37  - What you expected would happen
    38  - What actually happens
    39  - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
    40  
    41  People *love* thorough bug reports. I'm not even kidding.
    42  
    43  To make your life easier there is also a handy template available so feel free to use it.
    44  
    45  > ATTENTION: If you DONT provide steps to reproduce the ticket will be closed WITHOUT FURTHER NOTICE!
    46  
    47  ## License
    48  By contributing, you agree that your contributions will be licensed under its GPL-3.0.