If you're reading this, we would first like to thank you for taking the time to contribute.
The following is a set of guidelines for contributing to Lago and its packages, which are hosted in the Lago Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Lago is an open source project. When you initially consider contributing to Lago, you might be unsure about which of Lago elements implements the functionality you want to change or report a bug for. This section should help you with that.
Here's a list of Lago's elements:
- lago - The entry point of the lago application
- lago/front - Lago's UI
- lago/api - Lago's API.
- lago/openAPI - OpenAPI definition for the Lago API (you are here 📍)
- lago/client/go - Lago's Go Client
- lago/client/javascript - Lago's Javascript Client
- lago/client/python - Lago's Python Client
- lago/client/ruby - Lago's Ruby Client
Also, because Lago is extensible, it's possible that a feature you've become accustomed to in Lago or an issue you're encountering isn't coming from a bundled package at all, but rather a community package you've installed. Each community package has its own repository too.
If you have a question around how we do things, check to see if it is documented in the wiki of the related repository. If it is not documented there, please open a new topic on Lago Discussions and ask your question.
This section guides you through submitting a bug report for Lago. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Check Lago Discussions for a list of common questions and problems.
- Determine which element the problem should be reported in.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've determined which element your bug is related to, create an issue and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Lago, e.g. which command exactly you used in the terminal, or how you started Lago otherwise. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If you're reporting that Lago crashed, include a crash report with a stack trace from the operating system. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of Lago) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Lago? What's the most recent version in which the problem doesn't happen? You can download older versions of Lago from the releases page.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of Lago are you using?
- What's the name and version of the OS you're using?
- Are you running Lago in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
- Which packages do you have installed?.
This section guides you through submitting an enhancement suggestion for Lago, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Check the documentation you might discover that the enhancement is already available. Most importantly, check if you're using the latest version of Lago.
- Determine which element the enhancement should be suggested in.
- Perform a cursory 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.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue and provide the following information:
- 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.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Lago 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 Lago users and isn't something that can or should be implemented as a community package.
- Specify which version of Lago you're using.
- Specify the name and version of the OS you're using.
Unsure where to begin contributing to Lago? You can start by looking through these good first issue and help-wanted labels:
- Good first issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
good first issueissues.
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.
Lago and all packages can be developed locally. For instructions on how to do this, see the dedicated section in the README or in the wiki of the related repository.
The process described here has several goals:
- Maintain Lago's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Lago
- Enable a sustainable system for Lago's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title - Use the Convention commits convention.
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. To help you find issues and pull requests, each label is listed with search links for finding open items with that label. We encourage you to read about other search filters which will help you write more focused queries.
The labels are loosely grouped by their purpose, but it's not required that every issue has a label from every group or that an issue can't have more than one label from the same group.
Please open an issue if you have suggestions for new labels.
| Label name | 🔎 | Description |
|---|---|---|
feature |
Issues | Feature requests. |
improvement |
Issues | Improvement requests (of existing features). |
documentation |
Issues | Feature requests. |
bug |
Issues | Confirmed bugs or reports that are very likely to be bugs. |
critical bug |
Issues | Confirmed critical bugs or reports that are very likely to be bugs. |
chore |
Issues | Chore related issues |
help wanted |
Issues | The Lago core team would appreciate help from the community in resolving these issues. |
good first issue |
Issues | Less complex issues which would be good first issues to work on for users who want to contribute to Lago. |
wontfix |
Issues | The Lago core team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
dependencies |
Issues | Issues reported on the wrong repository |
| Label name | 🔎 | Description |
|---|---|---|
needs-review |
PR | Pull requests which need code review, and approval from maintainers or Lago core team. |
requires-changes |
PR | Pull requests which need to be updated based on review comments and then reviewed again. |
review-approved |
PR | That has been approved |