Repository: ignite Updated Branches: refs/heads/master e8d0831ff -> c55a75aa9
Create CONTRIBUTING.md - Fixes #5654. Signed-off-by: Dmitriy Pavlov <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/c55a75aa Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/c55a75aa Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/c55a75aa Branch: refs/heads/master Commit: c55a75aa91facaf604ad2b8d8d62f13f58d49c7d Parents: e8d0831 Author: Dmitriy Pavlov <[email protected]> Authored: Wed Dec 12 18:49:30 2018 +0300 Committer: Dmitriy Pavlov <[email protected]> Committed: Wed Dec 12 18:49:30 2018 +0300 ---------------------------------------------------------------------- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/c55a75aa/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9a8cc18 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to Apache Ignite +## Joining Community and it's communication channels +- Sign-in to Apache JIRA https://issues.apache.org/jira/ +- Subscribe to both Apache [User List - [email protected]](https://lists.apache.org/[email protected]) +and [Dev List - [email protected]](https://lists.apache.org/[email protected]) lists with your personal (non-corporate) email address. + Optionally you can subscribe to [Notifications List - [email protected]](https://lists.apache.org/[email protected]). + + To subscribe to any list in [Apache Software Foundation](apache.org) you can send email to `list_name`[email protected], e.g. to [email protected] and follow instructions. + +- Send a welcome message to the dev list to introduce yourself to the community and saying that you're going to contribute. +Request access to Apache Ignite JIRA in the same email sharing your JIRA ID. + +## How To Contribute +Detailed guidelines on How To Contribute can be found in [Apache Ignite wiki](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute) + +## Project Initial Setup +Create Apache Ignite code fork using GitHub interface. +Download sources locally and setup project according [Project Setup wiki](https://cwiki.apache.org/confluence/display/IGNITE/Project+Setup) + +## Code inspections, styles and abbreviation rules. +[Code style](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines) is specified Apache Ignite [Coding Guidelines](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines) . + +Please install following components for development using IntelliJ IDEA +* Install [Abbreviation Plugin](https://cwiki.apache.org/confluence/display/IGNITE/Abbreviation+Rules#AbbreviationRules-IntelliJIdeaPlugin). +* Code Inspection [Code Inspection Profile](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines#CodingGuidelines-C.CodeInspection). +Inpection profile is placed to IDEA [Project_Default](.idea/inspectionProfiles/Project_Default.xml) and it should be applied automatically . +* Configure [IDEA Codestyle](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines#CodingGuidelines-A.ConfigureIntelliJIDEAcodestyle).
