Files
vidgear/docs/contribution.md
abhiTronix 41d2ba1c7f 📝 Docs: Overhaul to mkdocs theme and Picamera2 installation doc.
- 📝 Added new `navigation.tabs.sticky`, `navigation.tracking`, `navigation.instant`, and `navigation.instant.progress` features.
- 📱 Replaced docs font `Muli` with `Source Sans 3`.
- 💄 Added custom admonition icons to `mkdocs.yml`.
- 🚩 Added `enable_creation_date:true` and `fallback_to_build_date: true` to `git-revision-date-localized` plugin.
- 🚚 Migrated to new Google Analytics 4 in mkdocs.yml.
-  Added new `git-authors` plugin in `mkdocs.yml`.
-  Added new `tables` markdown extension.
- 🚩 Added `custom_fences` to `pymdownx.superfences` markdown extension.
- 🚩 Added `line_spans: __span` and `pygments_lang_class: true` parameters to `pymdownx.highlight` markdown extension.
- 🚩 Added `normalize_issue_symbols: true` to `pymdownx.magiclink` markdown extension.
-  Added complete Picamera2 library installation instructions for pip and source.
  - 🚚 Moved legacy picamera python library installation instructions to admonition.
-  Added new mkdocs feature dependency `mkdocs-git-authors-plugin`.
- 👥 Added missing version contributors to changelog.md
- 🧑‍💻 Added new icons to make headings more readable.
- 🗑️ Replace depreciated `materialx` with supported `extensions` emoji extension.
- 🩹 Fixed titles and indentations in various admonitions.
- 📝 Replaced permalink icon with default one.
- 🩹 Replaced wrong unsupported admonitions with supported ones.
- 🔥 Removed all custom admonition icons and color CSS from `custom.css`.
- 🙈 Added `.cache` directory to `.gitignore`.
- 🔥 Removed Twitter section from help and site metadata.
- 🩹 Fixed Ko-fi sponsorship heart hover effect in footer.
- 💄 Replace twemoji `heart` with `heart-pulse` fontawesome SVG.
- 🔥 Removed Gitter community chat sidecard js.
- 💄 Redefined spacing between sections.
- ✏️ Fixed small typos and hyperlinks.
2024-04-23 00:42:44 +05:30

3.8 KiB
Raw Permalink Blame History

VidGear Contribution

Contribution Overview

Contributions are welcome, We'd love your contribution to VidGear in order to fix bugs or to implement new features!

!!! tip "Contribution Opportunities ❤️"

If you're looking for something to work on, check for the [PR WELCOMED :mailbox_with_mail:](https://github.com/abhiTronix/vidgear/issues?q=is%3Aissue+is%3Aopen+label%3A%22PR+WELCOMED+%3Amailbox_with_mail%3A%22) labeled issues on our GitHub Repository.

Submission Guidelines

Submission Contexts

Got a question or problem? :material-lightbulb-question:

For quick questions, please refrain from opening an issue, instead read our FAQ & Troubleshooting section or you can reach us on Gitter community channel.

Found a typo? :material-eraser:

There's no need to contribute for some typos. Just reach us on Gitter ➶ community channel, We will correct them in (less than) no time.

Found a bug? :material-bug-outline:

If you encountered a bug, you can help us by submitting an issue in our GitHub repository. Even better, you can submit a Pull Request(PR) with a fix, but make sure to read the guidelines ➶.

Request for a feature/improvement? :material-new-box:

??? tip "Subscribe to Github Repository"

You can [subscribe our GitHub Repository](https://github.com/abhiTronix/vidgear/watchers) to receive notifications through email for new pull requests, commits and issues that are created in VidGear. _Learn more about it [here ➶](https://help.github.com/en/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions)_

You can request our GitHub Repository for a new feature/improvement based on the type of request:

!!! note "Please submit an issue with a proposal template for your request to explain how it benefits everyone in the community."

  • Major Feature Requests: If you require a major feature for VidGear, then first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. The purposed feature, if accepted, may take time based on its complexity and availability/time-schedule of our maintainers, but once it's completed, you will be notified right away. Please be patient!

  • Minor Feature Requests: Small features and bugs resolved on priority. You just have to submit an issue to our GitHub Repository.