Skip to content
This repository has been archived by the owner on Oct 13, 2020. It is now read-only.

Latest commit

 

History

History
36 lines (19 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

36 lines (19 loc) · 1.89 KB
Raw

Contributing to IFC Documentation

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to IFC documentation, hosted at bigdoods/ifc-tech.org. 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

  • (tbc) - IFC project code of conduct.

Documentation and Site Decisions

  • (tbc) - IFC User group to hold discussion about documnetation for doc releases, suggested site improvements, and improving the doc contribution experience.

Style Guides and Templates

Before submitting a pull request to create new content, please review the IFC docs style guide and follow the instructions for using page templates.

Contributing to Documentation

Reporting Documentation Issues

IFC docs 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 IFC issues list as you might find out the issue is a duplicate.
  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.

Note that code issues should be filed against the main IFC repository, while documentation issues should go in the IFC docs repository.

Submitting Documentation Pull Requests

If you're fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow these instructions to create a documentation pull request against the IFC docs repository.