Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 3.76 KB
Raw

Contributing to mikrotik-rs 🤝

First off, thank you for considering contributing to mikrotik-rs! Welcome contributions from everyone as long as they adhere to our guidelines.

Code of Conduct

mikrotik-rs adheres to a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

How Can I Contribute?

Contributions to mikrotik-rs can be made in several ways, not just by modifying the project's code. Below are some ways you can contribute:

Reporting Bugs 🐛

This section guides you through submitting a bug report for mikrotik-rs. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🕵️‍♂️.

Before Submitting A Bug Report

  • Check the issue yourself - you might be able to find the cause of the problem and fix it yourself.
  • Determine which package/crate the problem is related to.
  • Perform a cursory search to see if the bug has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include (possibly) screenshots and console logs which demonstrate the problem.

Suggesting Enhancements ✨

This section guides you through submitting an enhancement suggestion for mikrotik-rs, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📢 and find related suggestions 🕵️‍♂️.

Before Submitting An Enhancement Suggestion

  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a 👍 to the existing suggestion.

How Do I Submit A (Good) Enhancement Suggestion?

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy-pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most mikrotik-rs users.
  • List some other projects where this enhancement exists if possible.

Pull Requests 📦

The process for submitting a pull request is as follows:

  • Fork the repository to your own GitHub account.
  • Clone the repository to your local device.
  • Create a new branch for your fix or feature.
  • Make the changes on your new branch.
  • Push your branch to your fork on GitHub.
  • From your fork, open a new pull request in the correct branch.
  • Once the pull request is approved and merged, you can pull the changes from upstream to your local repo and delete your extra branch(es).

Before Submitting A Pull Request

  • Check the code style and ensure your code follows the project style.
  • Check if the CI passes.
  • Add or update the documentation as needed.
  • Submit your pull request with a comprehensive description of your changes.

Questions?

Don't hesitate to ask! Open an issue and tag it as a question.

Once again, thanks for your interest in contributing to mikrotik-rs. We look forward to your contributions!