Skip to content
This repository has been archived by the owner on May 8, 2023. It is now read-only.

Latest commit

 

History

History
54 lines (29 loc) · 3.51 KB

contributing.md

File metadata and controls

54 lines (29 loc) · 3.51 KB

Contributing to Adobe Experience Manager Documentation

Thank you for choosing to contribute to Adobe Experience Manager documentation! We welcome content contributions from our entire reader community as well as from fellow Adobe employees.

This file describes how you can contribute as well as points out the guidelines to follow when making your contributions.

Adobe Open Source Code of Conduct

This project has adopted the Adobe Open Source Code of Conduct. By contributing to AEM documentation, you agree to adhere to this code of conduct. Please report unacceptable behavior to [email protected].

Guidelines for Contributing

While we welcome any contributions to improve AEM documentation, we do ask that contributions adhere to certain guidelines and standards where possible. Please review the Guidelines for Contributing to AEM Documentation for more information.

How to Contribute

We want to make it as easy as possible to submit your contributions. You can contribute in two ways:

Which method you choose depends on how comfortable you are editing the documentation in GitHub yourself.

Note

Contributions that you submit are covered by the Adobe terms of use.

Create an Issue {#create-an-issue}

Do you have a suggestion, observation about the current docs, or question the way something is described? Then please create an issue. Issues are also excellent if you have something to contribute, but don't feel comfortable editing the docs or making a pull request yourself.

Issues allow you to easily describe your idea for improvement to the docs and an AEM Docs Team member can review it. Simply click on the Log an issue link at the top of the right navigation panel on any page to create an issue.

Create a Pull Request {#create-a-pull-request}

If you see a problem and know exactly how to fix it, consider creating a pull request. Pull requests allow you to make your own edits to the documentation, which are then reviewed for inclusion by an AEM Docs Team member. Simply click on the Edit this page link at the top of the right navigation panel on any page to make your suggested changes and create the pull request.

All pull requests must be accompanied by a signed contributor license agreement or CLA. This gives Adobe permission to redistribute your contributions as part of the project. You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!

Quick Video Introduction

Have a look at the following video for a quick overview of how to create issues and pull requests.

!VIDEO

Contributions from Adobe Employees

If you are an Adobe employee and have a contribution, please use the AdobeDocs org in the corporate git.

We of course are happy for any contribution and will review your contribution if it is made on the public repository, however pull requests from Adobe employees are easier to process and can be approved faster on the corporate repo. Please make sure that any proprietary information is only discussed on the corporate repo.

Further Information

See the Adobe Docs Contributor Guide for further details on how to use the GitHub authoring platform.