Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3.15 KB

CONTRIBUTING.MD

File metadata and controls

75 lines (50 loc) · 3.15 KB

Contributing to FreePBX Unofficial Documentation

We welcome contributions from the community! This document outlines the guidelines for contributing to this repository.

How to Contribute

There are several ways you can contribute to this project:

  • Submit documentation: If you have written any documentation related to FreePBX development, you can share it by submitting a pull request.
  • Fix bugs: If you find any errors or inconsistencies in the documentation, please submit a pull request with the fix.
  • Improve existing documentation: Feel free to submit pull requests to improve the clarity, accuracy, or formatting of existing documentation.
  • Add new content: If there is a topic that you feel is missing from the documentation, you can submit a pull request to add a new markdown file.

Pull Request Guidelines

Before submitting a pull request, please follow these guidelines:

  • Fork the repository: Create a fork of this repository on GitHub.
  • Create a new branch: Make your changes on a new branch of your forked repository.
  • Make clear commits: Use clear and concise commit messages that describe the changes you have made.
  • Follow the coding style: If you are adding code examples, please follow the conventions used in the existing documentation.
  • Test your changes: Make sure your changes do not introduce any new errors or break existing functionality.
  • Submit a pull request: Once you are satisfied with your changes, submit a pull request to the main branch of this repository.

Code Style

  • File Naming: Use lowercase letters with hyphens (-) to separate words (e.g., database-interactions.md, troubleshooting-common-issues.md).
  • Headings: Use # for top-level headings, ## for secondary headings, and ### for tertiary headings.
  • Code Blocks: Use triple backticks (```) to create code blocks and specify the language for syntax highlighting.
  • Lists: Use hyphens (-) for unordered lists and numbers followed by periods (1., 2., 3., ...) for ordered lists.
  • Links: Use the format [Link Text](URL).
  • Images: Use the format ![Image Alt Text](path/to/image.jpg).
  • Whitespace: Use consistent indentation and add empty lines between paragraphs.
  • Grammar and Spelling: Proofread carefully for any errors.

Documentation Template

For consistency and readability, please use the following template for new documentation files:

---
title: <Title of the document>
author: <Your Name/Handle>
date: <Date of creation/last update>
---

# <Title of the document>

<Content of the document>

## <Subheading 1>

<Content for subheading 1>

### <Subheading 2>

<Content for subheading 2>

**Example:**

```bash
# Example code block
echo "Hello, World!"
```

Licensing

All contributions to this documentation are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. See the LICENSE.MD file for more details.

Contact

If you have any questions or need assistance contributing to this project, please feel free to create an issue on this repository.

We appreciate your contributions!