Skip to content

Contributing

Silva Tech edited this page Nov 13, 2024 · 2 revisions

Contributing to Silva MD Bot

First off, thank you for considering contributing to Silva MD Bot! Contributions are what make open-source projects like this one so amazing and help the community grow.

Whether you want to report a bug, suggest a feature, or submit code, this guide will help you get started.

Table of Contents

  1. How to Contribute
  2. Reporting Bugs
  3. Suggesting Features
  4. Submitting Code
  5. Code of Conduct

How to Contribute

There are a number of ways you can contribute to this project:

  • Reporting Issues: Found a bug? Think a feature can be improved? Let us know by opening an issue.
  • Suggesting Features: Have a feature in mind? We’d love to hear about it! Please open a feature request.
  • Submitting Code: Have a fix or enhancement? We welcome pull requests from contributors who want to make the bot better!

Reporting Bugs

If you encounter a bug while using Silva MD Bot, please follow these steps:

  1. Check if the issue has already been reported by searching the Issues section.
  2. If you can’t find an existing issue, feel free to open a new one.
  3. When creating the issue:
    • Be sure to provide detailed information about the bug (e.g., error messages, logs).
    • Include steps to reproduce the issue, if applicable.
    • Provide the version of the bot you're using and any other relevant information (e.g., operating system, Node.js version).

Suggesting Features

We love hearing about new ideas for features! To suggest a feature:

  1. Open an issue in the Issues section.
  2. Include a detailed description of the feature and why you think it would be a great addition to Silva MD Bot.
  3. If you have any mockups or visual ideas, feel free to include them!

Please ensure that the feature aligns with the goals of the project and doesn't overlap with existing features.


Submitting Code

If you want to fix a bug or add a new feature, follow these steps:

  1. Fork the repository: Click the Fork button at the top right of the repository page.

  2. Clone your fork: Clone your fork to your local machine using the following command:

    git clone https://github.com/YOUR_USERNAME/silva-md-bot.git
    git checkout -b your-branch-name
    git commit -m "Add feature/fix: Description of what you changed"
    git push origin your-branch-name
    
    

Explanation:

  • How to Contribute: Provides the different ways users can contribute to the project (e.g., reporting bugs, suggesting features, or submitting code).
  • Reporting Bugs: Details the process for users to report issues, including what information to include when opening a bug report.
  • Suggesting Features: Explains how users can suggest new features for the bot and provides steps for submitting feature requests.
  • Submitting Code: Guides users on how to fork the repository, clone it, create a branch, make changes, and submit a pull request.
  • Code of Conduct: Includes a reminder of the project’s code of conduct, emphasizing respect and inclusivity in the community.

Silva MD Bot Wiki Sidebar

Additional Resources


About

  • SilvaTechB: Developer of Silva MD Bot, passionate about WhatsApp bots and API-driven applications.
Clone this wiki locally