Skip to content

Commit

Permalink
chore: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jckdotim authored Aug 29, 2019
1 parent 3cd534e commit a8721b1
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# How to contribute to LINK Chain

First of all, thank you so much for taking your time to contribute!
It will be amazing if you could help us by doing any of the following:

- File an issue in [the issue tracker](https://github.com/link-chain/link/issues) to report bugs and propose new features and
improvements.
- Ask a question by creating a new issue in [the issue tracker](https://github.com/link-chain/link/issues).
- Browse [the list of previously answered questions](https://github.com/link-chain/link/issues?q=label%3Aquestion).
- Contribute your work by sending [a pull request](https://github.com/link-chain/link/pulls).

## Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please sign
the ICLA (individual contributor license agreement). Please
[contact us](mailto:dl_oss_dev@linecorp.com) if you need the CCLA (corporate contributor license agreement).

## Code of conduct

We expect contributors to follow [our code of conduct](https://github.com/link-chain/link/blob/master/CODE_OF_CONDUCT.md).

## Setting up your IDE

TBD

## Commit message and Pull Request message

- Please follow [Conventional Commit](https://www.conventionalcommits.org) to release note automation.
- Don't mention or link BTS of internal service that can't accessable from public.
- Please use english only.

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Please fill out every Pull request template's sections. It makes reviewers to review your PR easier.
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.

0 comments on commit a8721b1

Please sign in to comment.