Skip to content

Contribute

First and foremost, thank you for considering contributing to our knowledge base! Every contribution, whether it's a typo fix or a new article, helps us improve and grow. This document provides guidelines and steps for contributing.

Code of Conduct

The most recent version of our code of conducs can be viewed here.

By participating, you are expected to uphold this code. Please report unacceptable behavior to openroboticmetaverse@gmail.org.

How Can I Contribute?

Reporting Bugs

  • Check if the issue is already reported.
  • Provide a clear and descriptive title.
  • Describe the expected behavior and what you actually experienced.
  • Include screenshots and animated GIFs if possible.

Suggesting Enhancements

  • Provide a clear and descriptive title.
  • Explain why this enhancement would be useful to most users.
  • List some other platforms where this enhancement exists, if applicable.

Submission Guidelines

Writing Content

  • Use clear, concise, and simple language.
  • Ensure content is up-to-date and accurate.
  • Use headers and subheaders to organize content.
  • Avoid jargon or overly technical language.

Submitting a Pull Request

  1. Fork the Repository: Start by forking our repository on GitHub.
  2. Clone Your Fork: Clone your forked repository to your local machine.
  3. Make Your Changes: Edit the files and make your changes.
  4. Pull Request: Submit a pull request from your fork to the main repository.

Your pull request will be reviewed by the maintainers, who might ask for some changes or clarification. Once approved, your contribution will be merged. Congratulations and thank you!