2022-02-07 15:34:12 +08:00
# Contributing
# # Create pull request
PR are always welcome , even if they only contain small fixes like typos or a few lines of code . If there will be a significant effort , please document it as an issue and get a discussion going before starting to work on it .
2022-08-25 16:09:21 +08:00
Please submit a PR broken down into small changes ' bit by bit . A PR consisting of a lot of features and code changes may be hard to review . It is recommended to submit PRs in an incremental fashion .
2022-02-07 15:34:12 +08:00
2022-08-25 16:09:21 +08:00
This [ development guideline ] ( https : //dataease.io/docs/dev_manual/dev_manual/) contains information about repository structure, how to set up development environment, how to run it, and more.
2022-02-07 15:34:12 +08:00
Note : If you split your pull request to small changes , please make sure any of the changes goes to master will not break anything . Otherwise , it can not be merged until this feature complete .
# # Report issues
It is a great way to contribute by reporting an issue . Well - written and complete bug reports are always welcome ! Please open an issue and follow the template to fill in required information .
Before opening any issue , please look up the existing issues to avoid submitting a duplication .
If you find a match , you can " subscribe " to it to get notified on updates . If you have additional helpful information about the issue , please leave a comment .
When reporting issues , always include :
* Which version you are using .
* Steps to reproduce the issue .
* Snapshots or log files if needed
2022-08-25 16:09:21 +08:00
Because the issues are open to the public , when submitting files , be sure to remove any sensitive information , e . g . username , password , IP address , and company name . You can
2022-02-07 15:34:12 +08:00
replace those parts with " REDACTED " or other strings like " **** " .
