Repository: ignite Updated Branches: refs/heads/master eb0584b0d -> 2bf085e87
Contibuting.md was added to exclude for license check. 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/2bf085e8 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/2bf085e8 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/2bf085e8 Branch: refs/heads/master Commit: 2bf085e877a8799f37f79548e95bbdf5f4aacf0c Parents: eb0584b Author: Dmitriy Pavlov <[email protected]> Authored: Thu Dec 13 13:19:58 2018 +0300 Committer: Dmitriy Pavlov <[email protected]> Committed: Thu Dec 13 13:21:54 2018 +0300 ---------------------------------------------------------------------- CONTRIBUTING.md | 25 +++++++++++++++++-------- parent/pom.xml | 1 + 2 files changed, 18 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/2bf085e8/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 16a74f7..4408564 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # 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 code patches) Sing-in to [Apache Ignite](https://ignite.apache.org/) 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. @@ -10,7 +10,7 @@ and [Dev List - [email protected]](https://lists.apache.org/list.html?dev@ig 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. +Request access to [Apache Ignite JIRA](https://issues.apache.org/jira/) in the same email sharing your JIRA ID. Example of message: ``` Hello Ignite Community! @@ -21,31 +21,40 @@ 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. +[Apache Ignite](https://ignite.apache.org/) 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. +We value user support on the list, as well as providing a summary of [user list](https://lists.apache.org/[email protected]) threads to Apache Ignite developers. ## 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) -Apache Ignite follows [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html) +Apache Ignite follows [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html). You can also cover +[Etiquette Guide](http://community.apache.org/contributors/etiquette) -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) +Apache Ignite prefer to use [consensus to make decisions](http://community.apache.org/committers/consensusBuilding.html), 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. + - Markdown files, visible at GitHub, e.g. README.md; drawings explaining Apache Ignite & product internals. - Javadocs for packages (package-info.java), classes, methods, etc. +## Blogs +You can also blog about the product. It helps users to understand how to use Apache Ignite and helps spreading ideas. + +Feel free to share link to your blog with + [User](https://lists.apache.org/[email protected]) & [Dev](https://lists.apache.org/[email protected]) lists. +Blogs are reffered from [Apache Ignite Blogs](https://ignite.apache.org/blogs.html). + ## Contributing Code ### Project Initial Setup -Create Apache Ignite code fork using GitHub interface. +Create [Apache Ignite code](https://github.com/apache/ignite) fork using GitHub interface. 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 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) . +Project code style 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). http://git-wip-us.apache.org/repos/asf/ignite/blob/2bf085e8/parent/pom.xml ---------------------------------------------------------------------- diff --git a/parent/pom.xml b/parent/pom.xml index 2032f1d..bed124f 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -840,6 +840,7 @@ <exclude>**/*.sql</exclude><!--sql files--> <exclude>**/*README*.txt</exclude><!--readme files--> <exclude>**/*README*.md</exclude><!--readme files--> + <exclude>**/*CONTRIBUTING*.md</exclude><!--readme files--> <exclude>**/*index*.md</exclude><!--readme files--> <exclude>**/*.timestamp</exclude><!--tmp-files--> <exclude>**/*.iml</exclude><!--IDEA files-->
