Repository: ignite Updated Branches: refs/heads/master c55a75aa9 -> 859c385e9
Contributing instructions updated Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/859c385e Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/859c385e Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/859c385e Branch: refs/heads/master Commit: 859c385e943cc38ad1b975ace85c3480c0981aeb Parents: c55a75a Author: Dmitriy Pavlov <[email protected]> Authored: Wed Dec 12 19:55:56 2018 +0300 Committer: Dmitriy Pavlov <[email protected]> Committed: Wed Dec 12 19:55:56 2018 +0300 ---------------------------------------------------------------------- CONTRIBUTING.md | 48 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/859c385e/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a8cc18..16a74f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,61 @@ # Contributing to Apache Ignite ## Joining Community and it's communication channels - Sign-in to Apache JIRA https://issues.apache.org/jira/ +- (To contribute code patches) Sing-in to Apache Ignite Continuous Integration server https://ci.ignite.apache.org/ +- (To contribute documentation to the wiki) Sing-in to [Apache Wiki](https://cwiki.apache.org/confluence/display/IGNITE) - 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]). + 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. + To subscribe to any list in the [Apache Software Foundation](https://www.apache.org/foundation/) 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. +Example of message: +``` +Hello Ignite Community! + +My name is Aristarkh. I want to contribute to Apache Ignite and want to start with this issue - IGNITE-NNNNN, my JIRA username Aristarkh. Any help on this will be appreciated. + +Thanks! +``` + +## Needed Contributions +Apache Ignite Community values any type of contributions from [CoPDoc](https://community.apache.org/contributors/#contributing-a-project-copdoc). Community member can contibute to any areas from (Co)mmunity, (P)roject, (Do)cumentation, and (C)ode. + +Community values code contributions, but project value non-code contributions too, from writers, editors, testers, etc. ## 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) +Detailed guidelines on [How To Contribute](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute) can be found in [Apache Ignite wiki](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute) -## Project Initial Setup +Apache Ignite follows [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html) + +Apache Ignite prefer to use consensus to make decisions, but in case something is going wrong please see [Escalation Guide](https://www.apache.org/board/escalation) + +## Contributing Documentation +Documentation can be contributed to + - End-User documentation https://apacheignite.readme.io/ . Use Suggest Edits. + - Developer documentation, design documents, IEPs [Apache Wiki](https://cwiki.apache.org/confluence/display/IGNITE). Ask at [Dev List](https://lists.apache.org/[email protected]) to be added as editor. + - Markdown files, visible at GitHub, e.g. README.md; drawings explaining Ignite. + - Javadocs for packages (package-info.java), classes, methods, etc. + +## Contributing Code +### 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) +Download sources locally and setup project according to [Project Setup wiki](https://cwiki.apache.org/confluence/display/IGNITE/Project+Setup) -## Code inspections, styles and abbreviation rules. +### 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 . +Inspection 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). + +### Building project +Usually all Maven builds are to be run with skipped tests: +``` +mvn -DskipTests +``` +See also [DEVNOTES.txt](DEVNOTES.txt) \ No newline at end of file
