Guide to Contributing Modules

Welcome to our project! This guide provides step-by-step instructions on how to contribute to various types of module repositories within our organization. For this example, we will reference the pmods repository, but the same process applies to other module repositories.

Step 1: Understand the Repository Structure

Each repository (e.g., pmods) is dedicated to a specific type of module. Within these repositories, there is a modules directory. Your contribution should be placed in a separate folder inside this modules directory.

Ensure you select the correct repository for the type of module you are contributing.

Step 2: Fork and Clone the Repository

  1. Fork the Repository: Navigate to the repository (e.g., pmods) on GitHub and click the "Fork" button to create a copy under your GitHub account.
  2. Clone Your Fork: Clone the forked repository to your local machine.

Step 3: Create Your Module

  1. Create a New Folder: Inside the modules directory, create a new folder for your module. The folder name should be descriptive of your module.

  2. Develop Your Module: Add your module files to this new folder. This might include source code, design files, images, etc.

Step 4: Document Your Module

  1. Create a Markdown File: Inside your module's folder, create a markdown (.md) file that describes your module. This documentation should include:
  2. The purpose and functionality of the module.
  3. Instructions on how to use the module.
  4. Any other relevant information or references.

Use Tags: At the beginning or end of your markdown file, include relevant tags that describe your module. Tags help categorize and make your module easily searchable.

For instance: Tags: Robotics, Sensor, Wireless

The file should be called README.md.

Step 5: Commit Your Changes

Step 6: Push and Create a Pull Request

  1. Push Your Changes: Push your changes to your forked repository.

  2. Create a Pull Request: Go to your forked repository on GitHub and click "New pull request." Target the main branch of the original repository. Fill in a descriptive title and description for your pull request.

  3. Include a concise yet descriptive title and summary for your PR.
  4. Remember, each PR must pass automated checks and will be reviewed by an authorized reviewer.

Step 7: Respond to Feedback

  • Once your pull request is submitted, it may be reviewed and you might receive feedback.
  • Be prepared to make revisions if necessary.

Step 8: PR Merges and Contributions

  • If your PR meets the required standards and passes the review, it will be merged into the repository.
  • Congratulations, you have successfully contributed a module!