Skip to content

Latest commit

 

History

History
63 lines (33 loc) · 4.22 KB

contributing.md

File metadata and controls

63 lines (33 loc) · 4.22 KB

Contributing to Adobe Experience Manager Documentation

Thank you for choosing to contribute to Adobe Experience Manager documentation! We welcome content contributions from our community and Adobe employees outside the documentation teams.

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 Grp-opensourceoffice@adobe.com.

Guidelines for Contributing to AEM Documentation

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

How to Contribute

How you contribute depends on who you are and the sort of changes you'd like to contribute:

Create an Issue

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

Minor Changes

To submit minor updates, click the Edit link in an article, which opens the source article in GitHub. Use the GitHub UI to make your updates. See the general Adobe Docs contributor guide for more information.

Minor corrections or clarifications you submit for documentation and code examples in this repo are covered by the Adobe terms of use.

Major Changes or New Articles from Community Members

If you're part of the Adobe community and want to create an article or submit major changes, click the Issues tab in the GitHub repository to submit an issue. This submission starts a conversation with the documentation team. You will need to work with the writer (or other Adobe employee) to publish new content.

If you submit a pull request with significant changes to documentation and code examples, you'll see a message in the pull request asking you to submit an online contribution license agreement (CLA). You must complete the online form before we can review your pull request.

Major Changes from Adobe Employees

If you are a technical writer, program manager, or developer from the product team for an Adobe Experience Cloud solution, and it's your job to contribute to or author technical articles, you should use the private repository at https://git.corp.adobe.com/AdobeDocs.

Adobe employees from other parts of the Adobe world should use the public repo for minor updates.

Contributor License Agreement

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

Tools and Setup

Community contributors can use the GitHub UI for basic editing or fork the repo to make major contributions.

See the Adobe Docs Contributor Guide for an overview of how to use the GitHub authoring platform.

How to Use Markdown to Format Your Topic

All the articles in this repository use GitHub flavored markdown. If you are not familiar with markdown, see:

Labels

In the public repository, automated labels are assigned to pull requests to help us manage the pull request workflow and to help let you know what's going on with your pull request:

  • Change sent to author: The author has been notified of the pending pull request.
  • ready-to-merge: Ready for review by our pull request review team.