Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.69 KB

How to Contribute

Mini Donkey aims to protect our critical privacy on all social networks. For the purpose of transparency, Mini Donkey is completely open-source. All kinds of contribution are appreciated! Let's make our privacy secure again!

Code & Docs Contributor Workflow

  • Open an issue
  • Comment on the issue to claim ownership
  • The code owner will assign you as the owner of the issue
  • Complete the work
  • Open a pull request and refer to the issue in the pull request
  • Make sure tests are up-to-date & passing
  • The code owner will conduct a code review
  • Resolve issues from the code review
  • The code owner will approve the pull request
  • Merge the pull request

For how to get started with the code, see the docs.

For first time contributors, see "good first issues" for good starter projects.

For all contributors, see "help wanted" for all avaiable projects.

Not finding anything interesting? No problem.

Feel free to come up with new ideas and open issues for them ;) Here is a list of things you can do (note that it's only a example, please feel free to go beyond that and be creative):

  • New features
  • Better user experience
  • Better design
  • Missing or confusing documentation
  • Code refactor
  • Automation ideas
  • Stand-alone project that can make Mini Donkey better
  • and many more ...

Project Management Contributor Workflow

  • Go to the issues
  • Filter by labels ("need triage", "bug", etc)
  • Leave a comment to ping the related developers