Thank you for choosing to contribute to AEM.Design project, we really appreciate your time and effort! 😃🎊
The following are a set of guidelines for contributing to the project.
This project adheres to the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the team.
There are many ways of contributing, from testing and reporting an issue to suggesting and coding full components or features. Below is a summary of some of the best ways to get involved.
You can add your voice to discussions around new and existing component features by commenting on an Enhancements. New components and features that openly invite public comment are marked by an enhancement (Enhancement) label. We strongly encourage users of the framework to bring their own project experience to these issues, as there may be alternative use-cases or requirements that haven't yet been considered.
- 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 on a clean instance and that the actual behavior versus the expected results can be easily described.
- Check that the issue you are experiencing is related to the aem.design framework. It may be that the problem derives from AEM itself, Core Component or ACS Commons. If you're not sure, then feel free to report the issue anyway and the committers will clarify for you.
- 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.
- Have a quick search through the currently open enhancement 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 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.
- Visit our issue tracker on GitHub.
- File a
New Issueas aEnhancement. - Ensure your issue follows the issue report guidelines.
- Thanks for the feature request! The committers will get back to you in a timely manner, typically within one week.
High quality code is important to the project, and to keep it that way, all code submissions are reviewed by committers before being accepted. A 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.
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.
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 would like to contribute to the project but don't have an issue in mind? Or are 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.
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 Text Component Documentation), this contributing guide or our GitHub Wiki pages are good places to start.
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.
Once an issue is reported, the project committers will assign it a relevant label. You can see our label list on GitHub to better understand what each label means.