Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 2.05 KB

Contributing to DCE 5.0 Documentation

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to DCE 5.0 documentation, hosted at docs.daocloud.io. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Before you get started

Code of conduct

DaoCloud follows the Cloud Native Computing Foundation (CNCF) Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the DaoCloud Code of Conduct Committee.

Documentation and site decisions

The DaoCloud Docs Discussion Group is the discussion group for doc releases, suggested site improvements, and improving the doc contribution experience. If you are planning to be a regular contributor, join this group to stay informed and involved.

Style guides and templates

Before submitting a pull request to create new content, please review the tips about writing.

Contributing to documentation

Reporting documentation issues

DCE 5.0 uses github issues to track documentation issues and requests. If you see a documentation issue, submit an issue using the following steps:

  1. Check the DCE 5.0 issues list as you might find out some open/closed issues are helpful.
  2. Use the included template for every new issue. When you create a bug report, include as many details as possible and include suggested fixes to the issue.

Submitting documentation pull requests

If you're fixing an issue in the existing documentation, you should submit a PR against the main branch.

For more information, see contributing to DCE 5.0 docs.