[
https://issues.apache.org/jira/browse/KYLIN-4799?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17222693#comment-17222693
]
ASF GitHub Bot commented on KYLIN-4799:
---------------------------------------
joey-yoonsung opened a new pull request #1466:
URL: https://github.com/apache/kylin/pull/1466
## Proposed changes
There are documents for developers on the website. Placing CONTRIBUTING.md
in the root of the GitHub repository is defacto-standard but this project
doesn't. I create a `CONTRIBUTING.md` file and make it refer to documents on
the official website of Kylin. I expect this makes other developers easy to
access to development guide.
## Types of changes
What types of changes does your code introduce to Kylin?
_Put an `x` in the boxes that apply_
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Documentation Update (if none of the other choices apply)
## Checklist
_Put an `x` in the boxes that apply. You can also fill these out after
creating the PR. If you're unsure about any of them, don't hesitate to ask.
We're here to help! This is simply a reminder of what we are going to look for
before merging your code._
- [x] I have create an issue on [Kylin's
jira](https://issues.apache.org/jira/browse/KYLIN), and have described the
bug/feature there in detail
- [ ] Commit messages in my PR start with the related jira ID, like
"KYLIN-0000 Make Kylin project open-source"
- [ ] Compiling and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature
works
- [ ] If this change need a document change, I will prepare another pr
against the `document` branch
- [ ] Any dependent changes have been merged
## Further comments
If this is a relatively large or complex change, kick off the discussion at
user@kylin or dev@kylin by explaining why you chose the solution you did and
what alternatives you considered, etc...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Let me know contribution guide
> ------------------------------
>
> Key: KYLIN-4799
> URL: https://issues.apache.org/jira/browse/KYLIN-4799
> Project: Kylin
> Issue Type: Improvement
> Reporter: yoonsung.lee
> Priority: Trivial
> Labels: documentation
>
> Hi. I'm preparing to solve some issues that I'm interested in.
> I cannot find CONTRIBUTING.md and CODE_OF_CONDUCT.md in the Github repository.
>
> Please let me know. If there doesn't exist, please consider making it to
> invigorate this project. The contribution guide will make the code of this
> project reliable and reduce communication costs.
>
> The followings are some properties that I expect it in the contribution guide.
> * Code style schema for IDE such as IntelliJ, vscode, vim, and etc.
> * Copyright header.
> * Guide for null check in Java.
> * Guide for access modifier in Java
> * Guide to organize code in a java class.
> * Guide for the message of exception or log.
> * Guide for write Javadoc when creating a class.
> * Rest API convention.
> * etc...
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
