Skip to content
This repository has been archived by the owner on Nov 7, 2022. It is now read-only.

Latest commit

 

History

History
43 lines (28 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 2.42 KB

Contribute to MashCard

Welcome and thank you for your interest in contributing to MashCard FOSS Edition. MashCard is developed in the open and continually improved by our users, contributors, and maintainers. It is because of you that we can bring great software to the community.

This guide provides information on filing issues and guidelines for open source contributors. Please leave comments/suggestions if you find something is missing or incorrect.

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in MashCard, and instead to refer to our security policy.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

P.S. In addition to Open Source Development, there are also Documentation, Translation, and UX Design tracks. Documentation, Translation, and UX Design are all just as important as code.

Set up your development environment

This guide will help you set up your development environment for MashCard.

Submission Guidelines

Please follow these guidelines when submitting a pull request.

Style Guides

Please follow these style guidelines to ensure your work is consistent with the rest of the community:

Thank you for your contribution! 🤝