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

Latest commit

 

History

History
43 lines (31 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.75 KB
Raw

Contributing to Markdownpedia

We love your contribution!

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

All Code Changes Happen Through Pull Requests

Pull requests are the way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Markdownpedia would not be possible without your contributions. You can resolve the issues listed here.

note: Use the search feature to make sure an issue doesn’t already exist.

and also make sure to check the below ,

  • Titles are important - Give a short and conveying title for the issue.
  • Format your issues - Format your issues with relevent links and images describing the problem.

License

By contributing, you agree that your contributions will be licensed under its MIT License.