Repository: incubator-apex-site Updated Branches: refs/heads/master b2a796351 -> 129bee4df
APEXCORE-180 #comment added code style section Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/129bee4d Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/129bee4d Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/129bee4d Branch: refs/heads/master Commit: 129bee4dff5dd9790e15f698e640631629f8ad59 Parents: b2a7963 Author: Chandni Singh <[email protected]> Authored: Fri Dec 18 00:35:49 2015 -0800 Committer: Chandni Singh <[email protected]> Committed: Fri Dec 18 00:35:49 2015 -0800 ---------------------------------------------------------------------- src/md/contributing.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/129bee4d/src/md/contributing.md ---------------------------------------------------------------------- diff --git a/src/md/contributing.md b/src/md/contributing.md index 963123b..a2c3657 100644 --- a/src/md/contributing.md +++ b/src/md/contributing.md @@ -11,7 +11,7 @@ This project welcomes new contributors and invites everyone to participate. Our * Organize meetups and other events * Publishing papers and blogs * Present at conferences or spread the word in other ways - + People that help with the project in any of the above categories or other ways are contributors. See the [roles](http://www.apache.org/foundation/how-it-works.html#roles) as defined by the ASF. ## Becoming a committer @@ -24,6 +24,16 @@ A committer will be considered âemeritus/inactiveâ by not contributing in an The Podling Project Management Committee ([PPMC](http://incubator.apache.org/guides/ppmc.html)) is responsible for the oversight of the project and it also decides who to add as a PPMC member. Existing committers may be invited to become a PPMC member after consistent contribution and activity over a period of time and participation in directional and community building discussions. +## Code Style +Apache Apex follows coding style that is closest to K & R style and uses [Checkstyle](http://checkstyle.sourceforge.net/) tool to enforce these standards. Travis CI will fail for any pull request that introduces any style violations. + +The checkstyle configuration that Apache Apex projects use is present here : https://github.com/apache/incubator-apex-core/blob/devel-3/apex_checks.xml + +To make it easier for the users to set up their development environment, settings for the following common IDEs are provided in the Apache Apex Core repository with instructions. + - [IntelliJ](https://github.com/apache/incubator-apex-core/tree/devel-3/misc/ide-templates/intellij) + - [Eclipse](https://github.com/apache/incubator-apex-core/tree/devel-3/misc/ide-templates/eclipse) + - [NetBeans](https://github.com/apache/incubator-apex-core/tree/devel-3/misc/ide-templates/netbeans) + ## Opening Pull Requests (contributors) The apex-core and apex-malhar repositories both have mirror repositories on github which are used to review pull requests and provide a second remote endpoint for the codebase.
