Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

92 lines (62 loc) · 4.04 KB
Raw

Contributing to sqlxb

It is warmly welcomed if you have interest to hack on sqlxb. First, we encourage this kind of willing very much. And here is a list of contributing guide for you.

Topics

Reporting security issues

Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of sqlxb, please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to [email protected] to report this.

Reporting general issues

To be honest, we regard every user of sqlxb as a very kind contributor. After experiencing sqlxb, you may have some feedback for the project. Then feel free to open an issue via NEW ISSUE.

Since we collaborate project sqlxb in a distributed way, we appreciate WELL-WRITTEN, DETAILED, EXPLICIT issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.

To make the issue details as standard as possible, we setup an ISSUE TEMPLATE for issue reporters. Please BE SURE to follow the instructions to fill fields in template.

There are a lot of cases when you could open an issue:

  • bug report
  • feature request
  • performance issues
  • feature proposal
  • feature design
  • help wanted
  • doc incomplete
  • test improvement
  • any questions on project
  • and so on

Also we must remind that when filling a new issue, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.

Code and doc contribution

Every action to make project sqlxb better is encouraged. On GitHub, every improvement for sqlxb could be via a PR (short for pull request).

  • If you find a typo, try to fix it!
  • If you find a bug, try to fix it!
  • If you find some redundant codes, try to remove them!
  • If you find some test cases missing, try to add them!
  • If you could enhance a feature, please DO NOT hesitate!
  • If you find code implicit, try to add comments to make it clear!
  • If you find code ugly, try to refactor that!
  • If you can help to improve documents, it could not be better!
  • If you find document incorrect, just do it and fix that!
  • ...

Actually it is impossible to list them completely. Just remember one principle:

WE ARE LOOKING FORWARD TO ANY PR FROM YOU.

Since you are ready to improve sqlxb with a PR, we suggest you could take a look at the PR rules here.

Workspace Preparation

git clone https://github.com/x-ream/sqlxb.git
or fork it ....

For test:
git clone https://github.com/sim-wangyan/sqlxb-test-on-sqlx.git
or fork it ....

Test case contribution

Any test case would be welcomed. Currently, sqlxb function test cases are high priority. Welcome to submit PR of test case to https://github.com/sim-wangyan/sqlxb-test-on-sqlx ,
or to your own project like https://github.com/xxxxx/sqlxb-test-xxxxx

Engage to help anything

We choose GitHub as the primary place for sqlxb to collaborate. So the latest updates of sqlxb are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.

  • reply to other's issues if you could;
  • help solve other user's problems;
  • help review other's PR design;
  • help review other's codes in PR;
  • discuss about sqlxb to make things clearer;
  • advocate sqlxb technology beyond GitHub;
  • write blogs on sqlxb and so on.

In a word, ANY HELP IS CONTRIBUTION.