-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: added and configured contribution guide (#41)
- Loading branch information
Showing
1 changed file
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Contributing to this repository <!-- omit in toc --> | ||
|
||
Thank you for contributing to paymentpointers.org :tada: Your contributions are essential to making this project better. | ||
|
||
## Before you begin | ||
|
||
- Have you read the [code of conduct](code_of_conduct.md)? | ||
- Check out the [existing issues](https://github.com/interledger/paymentpointers.org/issues) & see if we [accept contributions](#types-of-contributions) for your type of issue. | ||
|
||
## Table of Contents <!-- omit in toc --> | ||
|
||
- [Types of contributions](#types-of-contributions) | ||
- [:beetle: Issues](#beetle-issues) | ||
- [:hammer_and_wrench: Pull requests](#hammer_and_wrench-pull-requests) | ||
- [:books: Documentation](#books-documentation) | ||
- [Working in the paymentpointers.org repository](#working-in-the-paymentpointersorg-repository) | ||
- [Labels](#labels) | ||
- [Language](#language) | ||
- [CI](#ci) | ||
- [Reporting Issues](#reporting-issues) | ||
- [Submitting Pull Requests](#submitting-pull-requests) | ||
- [Review Process](#review-process) | ||
|
||
## Types of contributions | ||
|
||
You can contribute to Payment pointers in several ways. | ||
|
||
### :beetle: Issues | ||
|
||
We use GitHub issues to track tasks that contributors can help with. We haven't finalized labels yet for contributors to tackle. If you want to help with work related to an issue, please comment on the issue before starting work on it. | ||
|
||
If you've found something that needs fixing, search open issues to see if someone else has reported the same thing. If it's something new, open an issue. We'll use the issue to discuss the problem you want to fix. | ||
|
||
### :hammer_and_wrench: Pull requests | ||
|
||
Feel free to fork and create a pull request on changes you think you can contribute. | ||
|
||
The team will review your pull request as soon as possible. | ||
|
||
### :books: Documentation | ||
|
||
We started to maintain public-facing documentation for Payment Pointers on [paymentpointers.org](https://github.com/interledger/paymentpointers.org/tree/main/src/content/docs). The project is new, and available documentation is currently WIP. | ||
|
||
## Working in the Paymentpointers.org repository | ||
|
||
You can use any package manager, However, we prefer pnpm. A list of steps for setting up a [local development environment](https://github.com/interledger/paymentpointers.org#local-development) can be found in the Readme. | ||
|
||
### Labels | ||
|
||
We use labels to communicate the intention of issues and PRs. | ||
|
||
- `documentation` issues that are improvements or additions to documentation. | ||
- `good first issue` are great issues for newcomers to take on. | ||
- `triage` issues that the core team needs to assign labels to. | ||
|
||
Some labels will be automatically assigned to PRs. | ||
|
||
### Language | ||
|
||
[Typescript](https://www.staging-typescript.org/) is the chosen language. | ||
|
||
```shell | ||
./tsconfig.json # config | ||
``` | ||
|
||
Typescript config at the root is intended to be a base config that should be extended by | ||
each package to suit the package's requirements. | ||
|
||
### CI | ||
|
||
We use GitHub actions to manage our CI pipeline. | ||
|
||
The workflows can be found in `.github/workflows` | ||
|
||
## Reporting Issues | ||
|
||
If you encounter any issues or have a feature request, please [create a new issue](https://github.com/interledger/paymentpointers.org/issues/new) and provide the following details: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the issue, including steps to reproduce if applicable. | ||
- Information about your environment (e.g., operating system, browser, version). | ||
- Any relevant screenshots or error messages. | ||
|
||
## Submitting Pull Requests | ||
|
||
1. [Fork](https://github.com/interledger/paymentpointers.org) the repository. | ||
2. Create a new branch from `main`. | ||
3. Make your changes and commit them. | ||
4. Create a pull request (PR) to `main`. | ||
5. Ensure your PR includes a clear title and description following the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/). | ||
6. If your PR addresses an issue, reference the issue in the description using `Closes #123`. | ||
7. Be patient and be prepared to address feedback and make changes if needed. | ||
|
||
## Review Process | ||
|
||
- Project maintainers will review your PR for code quality, correctness, and adherence to guidelines. | ||
- Please respond to any feedback promptly and make necessary changes. | ||
- Once the PR is approved, it will be merged into the main branch. | ||
|
||
Thank you for contributing to Payment pointers! We appreciate your time and effort in helping make [Paymentpointers.org](https://paymentpointers.org/) better. Join our community on [Slack](https://communityinviter.com/apps/interledger/interledger-working-groups-slack) to connect with other contributors and stay updated on project developments. | ||
|
||
Happy coding! |