Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

58 lines (34 loc) · 3.77 KB
Raw

Contributing to ACS AEM Commons

Here are some of the ways you can contribute to ACS AEM Commons:

  • Contribute new code: services, components, front end code, whatever…
  • File bug reports.
  • Fix bugs.
  • Develop ideas for new features and file them.
  • Participate in code reviews.

How to Contribute Code

New code contributions should be primarily made using GitHub pull requests. This involves you creating a personal fork of the project, adding your new code to a branch in your fork, and then triggering a pull request using the GitHub web UI (it's easier than it sounds). A pull request is both a technical process (to get the code from your branch into the main repository) and a framework for performing code reviews.

The branch naming conventions in your fork should follow projects name conventions.

For new features:

  • **feature/**meaningful-feature-name
    • ex. feature/component-error-handler

For defects:

  • **defect/**feature-name/short-name-of-problem-being-fixed
    • ex. defect/error-page-handler/parent-page-lookup

In many cases, it is worth having a discussion with the community before investing serious time in development. For these cases, create a GitHub issue of type "feature review" with a description of the problem you are trying to solve.

If you already have commit rights, bug fixes and minor updates should just be made in the shared repository itself.

When making any change, either directly or via a pull request, please be sure to add an entry to the CHANGELOG file.

There's a good guide to performing pull requests at https://help.github.com/articles/using-pull-requests. In the terms used in that article, we use both the Fork & Pull and the Shared Repository Model.

Before Contributing Code

The best pull request are small and focused. Don't try to change the world in one pull request. And while the focus of this project is reusability, that doesn't mean that every option under the sun needs to be available. Stick to the 80/20 rule and provide a way to extend for that extra 20% on a project.

  • Check code quality proactively by using CodeClimate CLI.
  • Ensure license is applied correctly by running mvn license:update-file-header
  • Add JUnit test for Java code. Our coverage ratio isn't great, but we don't want it to get worse.
  • Until explicitly enabled, features should be invisible to AEM users and excluded from any execution stack.
    • OSGi Services automatically registered as part of the stack should be annotated with policy = ConfigurationPolicy.REQUIRE. Common candidates include (but not limited to): Filters, Scheduled Services, Event Listeners and Authentication handlers.
    • Ex. Until a OSGi Configuration is added for the feature "Component Error Handler", this Sling Filter will remain inactive making it impossible to effect Request processing.

Version Compatibility

The master branch of ACS AEM Commons (4.x) is expected to be installable on AEM 6.3 and AEM 6.4. This means that all required OSGi dependencies must be available on 6.3. It is acceptable for some features to require AEM 6.4, but contributors are strongly encouraged to be thoughtful about requiring 6.4.

The compat/6.2 branch of ACS AEM Commons (3.x) is expected to be installable on AEM 6.2.

The compat/6.0 branch (2.x) is expected to be installable on AEM 6.0 and AEM 6.1.

Participating in Code Reviews

Even if you don't have time to contribute code, reviewing code contributed by other people is an option. To do this, go to https://github.com/Adobe-Consulting-Services/acs-aem-commons/pulls to see the open pull requests.