Thank you for choosing to contribute to the Adobe Experience Manager Core Components project, we really appreciate your time and effort! 😃🎊
The following are a set of guidelines for contributing to the project.
- Code of Conduct
- Ways to Contribute
- Contributing Code
- Issue Report Guidelines
- Contributor License Agreement
This project adheres to the Adobe Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the team.
There are many forms of contributions. New components or features, changes to existing features, tests, documentation, bug fixes, or just good suggestions. For any contribution to be considered, a related issue is always required.
The Core Component Engineering Team reviews all issues and contributions submitted by the community. During the review we might require clarifications from the contributor. If there is no response from the contributor within two weeks time, the issue will be closed.
Once a contribution is being reviewed, the Core Engineering Team will apply a relevant label to the associated issue. You can see our label list on GitHub to better understand what each label means.
- Have a quick search through the currently open bug reports to see if the issue has already been reported.
- Ensure that the issue is repeatable and that the actual behavior versus the expected results can be easily described.
- Check that the issue you are experiencing is related to the Core Components project. It may be that the problem derives from AEM itself, typically editor code, rather than the Core Components. If you're not sure, then feel free to report the issue anyway and the committers will clarify for you. Issues in the product can be reported via Adobe Enterprise Support.
- Visit our issue tracker on GitHub.
- File a
New Issueas aBug Report. - Ensure your issue follows the issue report guidelines.
- Thanks for the report! The committers will get back to you in a timely manner, typically within one week.
If you have a fix ready for a bug, submit a pull request and reference it in the associated issue.
Please Note: New experimental components and features should always go to aem-contrib-wcm-components repository by default. All feature submissions should be accompanied by a pull request
- Have a quick search through the currently open enhancement and request to comment issues to see if the idea has already been suggested. If it has, you may still have a slightly different requirement that isn't covered, in which case, feel free to comment on the open issue.
- Take a look at the Core Components Roadmap to see if your feature is already on the radar. If it is and doesn't have a public issue yet, feel free to create one, listing your own requirements.
- Consider whether your requirement is generically useful rather than project-specific and would therefore benefit all users of the Core Components.
Reviewing others' code contributions is another great way to contribute - more eyes on the code help to improve its overall quality. To review a pull request, check the open pull requests for anything you can comment on.
We very much welcome issue reports or pull requests that improve our documentation pages. While the best effort is made to keep them error free, useful and up-to-date there are always things that could be improved. The component documentation pages (for example the Image Component Documentation), this contributing guide or our GitHub Wiki pages are good places to start.
If you have questions about Core Components functionality or would like to submit a feature request or enhancement suggestions, we recommend posting them to the Core Components Developer Mailing List.
You can also add your voice to discussions around new and existing component features by commenting on an RTC. New components and features that openly invite public comment are marked by an RTC (Request to Comment) label.
High quality code is important to the project, and to keep it that way, all code submissions are reviewed by committers before being accepted. Close adherence to the guidelines below can help speed up the review process and increase the likelihood of the submission being accepted.
- Consider joining developer discussions to get feedback on what you are thinking of contributing. It's better to get this early feedback before going ahead and potentially having to rewrite everything later.
- Create a bug report or feature request issue summarizing the problem that you will be solving. This will again help with early feedback and tracking.
- Have a look at our component checklist, for an idea of what certifies a production-ready component.
- Ensure you have signed the Adobe Contributor License Agreement. If you are an Adobe employee, you do not have to sign the CLA.
The project accepts contributions primarily using GitHub pull requests. This process:
- Helps to maintain project quality
- Engages the community in working towards commonly accepted solutions with peer review
- Leads to a more meaningful and cleaner git history
- Ensures sustainable code management
Creating a pull request involves creating a fork of the project in your personal space, adding your new code in a branch and triggering a pull request. Check the GitHub Using Pull Requests article on how to perform pull requests.
Please base your pull request on the development branch and make sure to check you have incorporated or merged the latest changes! The maintainers will cherry-pick the change to master after it's successfully integrated and tested.
The title of the pull request typically matches that of the issue it fixes, see the issue report guidelines. Have a look at our pull request template to see what is expected to be included in the pull request description. The same template is available when the pull request is triggered.
Would you like to contribute to the project but don't have an issue in mind? Or are you still fairly unfamiliar with the code? Then have a look at our good first issues, they are fairly simple starter issues that should only require a small amount of code and simple testing.
A well defined issue report will help in quickly understanding and replicating the problem faced, or the feature requested. Below are some guidelines on what to include when reporting an issue. You can also see this community reported issue for an example of a well written issue report.
- Descriptive - Should be specific, well described and readable at a glance.
- Concise - If the issue can't be easily described in a short title, then it is likely unfocused.
- Keyword-rich - Including keywords can help with quickly finding the issue in the backlog. Component related issues can be prefixed with a bracketed label with the component name, for example
[Image]for the image component.
Bad title: Search component has security problems
Good title: [Search] Fulltext search of pages might lead to DDOS
See our bug report template or feature request template for details on what is expected to be described. The same information is available when creating a new issue on GitHub.
By contributing your code to the Adobe Marketing Cloud Github Organisation you grant Adobe a non-exclusive, irrevocable, worldwide, royalty-free, sublicensable, transferable license under all of Your relevant intellectual property rights (including copyright, patent, and any other rights), to use, copy, prepare derivative works of, distribute and publicly perform and display the Contributions on any licensing terms, including without limitation: (a) open source licenses like the Apache License, Version 2.0; and (b) binary, proprietary, or commercial licenses. Except for the licenses granted herein, You reserve all right, title, and interest in and to the Contribution.
You confirm that you are able to grant us these rights. You represent that You are legally entitled to grant the above license. If Your employer has rights to intellectual property that You create, You represent that You have received permission to make the Contributions on behalf of that employer, or that Your employer has waived such rights for the Contributions.
You represent that the Contributions are Your original works of authorship, and to Your knowledge, no other person claims, or has the right to claim, any right in any invention or patent related to the Contributions. You also represent that You are not legally obligated, whether by entering into an agreement or otherwise, in any way that conflicts with the terms of this license.
YOU ARE NOT EXPECTED TO PROVIDE SUPPORT FOR YOUR SUBMISSION, UNLESS AND EXCEPT TO THE EXTENT YOU CHOOSE TO DO SO. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND.