mirrors/lago
1
0
Fork 0
mirror of https://github.com/getlago/lago.git synced 2024-12-22 17:53:20 +07:00
Code Issues Packages Projects Releases Wiki Activity

chore: 📚 OSS Documentation

Browse Source
This commit is contained in:
MorganeLecurieux 2022-05-30 15:34:59 +02:00
parent bc69459b14
commit f4b917aa65
3 changed files with 375 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
dev@getlago.com.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

219
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,219 @@
# Contributing to Lago
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](https://github.com/getlago) 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.
#### Table Of Contents
[Code of Conduct](#code-of-conduct)
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
[What should I know before I get started?](#what-should-i-know-before-i-get-started)
- [Lago and Packages](#lago-and-packages)
- [Design Decisions](#design-decisions)
[How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Your First Code Contribution](#your-first-code-contribution)
- [Pull Requests](#pull-requests)
[Styleguides](#styleguides)
- [Git Commit Messages](#git-commit-messages)
- [JavaScript Styleguide](#javascript-styleguide)
- [CoffeeScript Styleguide](#coffeescript-styleguide)
- [Specs Styleguide](#specs-styleguide)
- [Documentation Styleguide](#documentation-styleguide)
[Additional Notes](#additional-notes)
- [Issue and Pull Request Labels](#issue-and-pull-request-labels)
## Code of Conduct
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [dev@getlago.com](mailto:dev@getlago.com).
## I don't want to read this whole thing I just have a question!!!
- [Github Discussions, the official Lago](https://github.com/getlago/lago/discussions)
- [Lago FAQ](https://github.com/getlago/lago/discussions)
- [Lago official documentation](https://doc.getlago.com/docs/guide/intro)
## What should I know before I get started?
### Lago and Packages
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/core](https://github.com/getlago/lago) - Lago Core!
- [lago/front](https://github.com/getlago/lago-front) - Lago's UI.
- [lago/front](https://github.com/getlago/lago-api) - Lago's API.
#### The different clients
- [lago/client/nodejs](https://github.com/getlago/lago-nodejs-client) - Lago's Nodejs Client
- [lago/client/python](https://github.com/getlago/lago-python-client) - Lago's Python Client
- [lago/client/ruby](https://github.com/getlago/lago-ruby-client) - 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.
### Design Decisions
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 [Github Discussions](https://github.com/getlago/lago/discussions) and ask your question.
## How Can I Contribute?
### Reporting Bugs
This section guides you through submitting a bug report for Lago. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) 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](#how-do-i-submit-a-good-bug-report). Fill out the required template (according to your repository), 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.
#### Before Submitting A Bug Report
- **Check the [discussions](https://github.com/getlago/lago/discussions)** for a list of common questions and problems.
- **Determine [which element the problem should be reported in](#lago-and-packages)**.
- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Agetlago)** 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.
#### How Do I Submit A (Good) Bug Report?
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined [which element](#lago-and-packages) 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](https://help.github.com/articles/markdown-basics/#multiple-lines).
- **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](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) 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](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) 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](https://github.com/getlago/lago/releases).
- **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](#lago-and-packages) do you have installed?**.
### Suggesting Enhancements
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 :pencil: and find related suggestions :mag_right:.
Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) 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](#how-do-i-submit-a-good-enhancement-suggestion). Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
#### Before Submitting An Enhancement Suggestion
- **Check the [documentation](https://doc.getlago.com/docs/guide/intro)** you might discover that the enhancement is already available. Most importantly, check if you're using [the latest version of Lago](https://github.com/getlago/lago/releases).
- **Determine [which element the enhancement should be suggested in](#lago-and-packages).**
- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Agetlago)** 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.
#### How Do I Submit A (Good) Enhancement Suggestion?
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined [which repository](#lago-and-packages) 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](https://help.github.com/articles/markdown-basics/#multiple-lines).
- **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](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) 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](#lago-and-packages).
- **Specify which version of Lago you're using.**
- **Specify the name and version of the OS you're using.**
### Your First Code Contribution
Unsure where to begin contributing to Lago? You can start by looking through these `beginner` and `help-wanted` labels:
- Beginner 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 `beginner` issues.
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.
#### Local development
Lago Core and all packages can be developed locally. For instructions on how to do this, see the following sections in the [Lago documentation](#):
### Pull Requests
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:
1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md)
2. Follow the [styleguides](#styleguides)
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>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.</details>
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.
## Styleguides
### Git Commit Messages
- 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](https://www.conventionalcommits.org/en/v1.0.0/) convention.
### Styleguide
All JavaScript code is linted with [Prettier](https://prettier.io/).
Make sure to check each repository wiki for more guidelines.
## Additional Notes
### Issue and Pull Request Labels
This section lists the labels we use to help us track and manage issues and pull requests.
[GitHub search](https://help.github.com/articles/searching-issues/) 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](https://help.github.com/articles/searching-issues/) 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.
#### Type of Issue and Issue State
| Label name | :mag_right: | Description |
| --------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `enhancement` | [Issues](https://github.com/getlago/lago/labels/enhancement) | Feature requests. |
| `documentation` | [Issues](https://github.com/getlago/lago/labels/documentation) | Feature requests. |
| `bug` | [Issues](https://github.com/getlago/lago/labels/bug) | Confirmed bugs or reports that are very likely to be bugs. |
| `question` | [Issues](https://github.com/getlago/lago/labels/question) | Questions more than bug reports or feature requests (e.g. how do I do X). |
| `help-wanted` | [Issues](https://github.com/getlago/lago/labels/help-wanted) | The Lago core team would appreciate help from the community in resolving these issues. |
| `beginner` | [Issues](https://github.com/getlago/lago/labels/beginner) | Less complex issues which would be good first issues to work on for users who want to contribute to Lago. |
| `duplicate` | [Issues](https://github.com/getlago/lago/labels/duplicate) | Issues which are duplicates of other issues, i.e. they have been reported before. |
| `wontfix` | [Issues](https://github.com/getlago/lago/labels/wontfix) | 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. |
| `invalid` | [Issues](https://github.com/getlago/lago/labels/invalid) | Issues which aren't valid (e.g. user errors). |
| `preview-environment` | [Issues](https://github.com/getlago/lago/labels/preview-environment) | Issues reported on the wrong repository |
#### Pull Request Labels
| Label name | :mag_right: | Description |
| ------------------ | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
| `needs-review` | [PR](https://github.com/getlago/lago-front/pulls?q=is%3Apr+is%3Aopen+review%3Arequired) | Pull requests which need code review, and approval from maintainers or Lago core team. |
| `requires-changes` | [PR](https://github.com/getlago/lago-front/pulls?q=is%3Apr+is%3Aopen+review%3Achanges-requested) | Pull requests which need to be updated based on review comments and then reviewed again. |
| `review-approved` | [PR](https://github.com/getlago/lago-front/pulls?q=is%3Apr+is%3Aopen+review%3Aapproved) | That has been approved |

28
PULL_REQUEST_TEMPLATE.md Normal file
View File

@ -0,0 +1,28 @@
## Pull Request template
Please, go through these steps before you submit a PR.
1. Make sure that your PR is not a duplicate.
2. If not, then make sure that:
a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`.
b. You have a descriptive commit message with a short title (first line).
c. You have only one commit (if not, squash them into one commit).
d. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`).
3. **After** these steps, you're ready to open a pull request.
a. Give a descriptive title to your PR.
b. Describe your changes.
c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
d. Add the corresponding labels to your pull request (ex: feature, improvement, bug...)
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**