Skip to content

Latest commit

 

History

History
54 lines (29 loc) · 3.43 KB

contributing.md

File metadata and controls

54 lines (29 loc) · 3.43 KB

Contributing to Adobe Experience Manager Screens Documentation

Thank you for choosing to contribute to Adobe Experience Manager Screens documentation! Adobe welcomes content contributions from the entire reader community and 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. Report unacceptable behavior to [email protected].

Guidelines for Contributing

While Adobe welcomes any contributions to improve AEM documentation, be sure that contributions adhere to certain guidelines and standards where possible. Review the Guidelines for Contributing to AEM Documentation for more information.

How to Contribute

Adobe wants 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 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 let you easily describe your idea for improvement to the docs and an AEM Docs Team member can review it. Click Log an issue 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 let you make your own edits to the documentation. An AEM Docs Team member reviews the edits for inclusion. Click Edit this page 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 have a contributor license agreement or CLA that is signed. The CLA 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, use the AdobeDocs org in the corporate git.

Adobe is happy for any contribution and reviews 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. 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.