From a8721b1bd93c1583c48087820601c4c4dbedfa54 Mon Sep 17 00:00:00 2001 From: JCKim Date: Thu, 29 Aug 2019 14:04:52 +0900 Subject: [PATCH] chore: add CONTRIBUTING.md --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..ce474bd59c --- /dev/null +++ b/CONTRIBUTING.md @@ -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. +