Skip to content

Latest commit

 

History

History
88 lines (74 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

88 lines (74 loc) · 3.03 KB

Contributing to Reserved words

Thank you for contributing to Reserved words We have some rules to contribute this project

How To Contribute

start our project

> yarn install
> yarn start

add data

If you want to add data, you have to follow the rules below.

want to add new version

  1. add data
    We manage reserved words under /public/data/{category}/{system}/{version}.json
    • ex) add data /public/DB/mysql/9.0.json
  2. add version data
    We manage version data under /public/data/{category}/versions.json
    • ex) add data on /public/DB/versions.json

want to add new recommends

  1. add data
    We manage reserved words alphabetically under /public/data/recommends/.
    • ex) add data on /public/data/recommends/a.json

commit

  • Must Follow commit Template
    (Need to set git config --local commit.template .github/.gitmessage.txt on your local)
  • link issue at resolves, see also
  • 1 commit 1 work(for history)

branch

  • we use gitflow Work Flow
  • ex) feature/(Issue Num)-(task)
  • When entering data, create a branch data/system-version and upload PR

pull requests

  • create pull request to develop branch after your task is done
  • code can merge after get at least 1 approve after reviews

code Check

  • must check diff and commit
    • Don't contain Personal Setting
    • Commit only the code for the specified task
  • check code conventions before commit

Developer Certificate of Origin

Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.