mirror of
https://github.com/1Panel-dev/1Panel.git
synced 2024-12-18 11:17:49 +08:00
25 lines
1.6 KiB
Markdown
25 lines
1.6 KiB
Markdown
|
# 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.
|
||
|
|
|
||
|
|
Please submit a PR broken down into small changes bit by bit. A PR consisting of a lot features and code changes may be hard to review. It is recommended to submit PRs in an incremental fashion.
|
||
|
|
|
||
|
|
This [development guideline](https://kubeoperator.io/docs/dev/dev_manual/) contains information about repository structure, how to setup development environment, how to run it, and more.
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
Because the issues are open to the public, when submitting files, be sure to remove any sensitive information, e.g. user name, password, IP address, and company name. You can
|
||
|
|
replace those parts with "REDACTED" or other strings like "****".
|