Contributing to forum

Thank you for considering contributing to forum! We welcome any help, be it in the form of bug reports, feature suggestions, documentation updates, or code contributions. Please read this document to ensure that your contributions follow the project's standards.

Good practices

Before submitting your contributions, please make sure to follow these good practices:

• Write clear and concise commit messages.
• Follow the established good practices of your language as well as the project's coding style.
• Test your changes thoroughly.
• Provide documentation when necessary.
• Be respectful and constructive in your interactions with other contributors.

Naming conventions

• Use lowercase for all file and folder names.
• For multi-word HTML, CSS, and JavaScript file names use kebab-case (e.g., my-file-name), and for Golang use snake_case (e.g., my_file_name).
• Use kebab-case for HTML element and attribute names (e.g., my-element-name).
• Use BEM (Block Element Modifier) methodology to structure your CSS code. (e.g., block__element--modifier).
• Use camelCase for Golang and JavaScript variable and function names.
• Use PascalCase for Golang and JavaScript struct, interface, class, and constructor names.
• Use UPPER_CASE for Golang and JavaScript constants.
• Use an underscore prefix (e.g., _myPrivateProperty) when declaring private properties in JavaScript.

Code organization

All Golang code should be located in the ./src directory, following the standard Go project structure. The ./public directory contains all HTML, CSS, and JavaScript files.

Getting started

To get started, fork the repository and create a new branch for your changes. Then, make your changes and submit a pull request. We will review your changes as soon as possible.

License

By contributing to forum, you agree that your contributions will be licensed under the MIT License [License TBD].