Unearthlyglow / micr-ccm

Open source Musical Instrument Compendium and Registry project for the community.
GNU General Public License v3.0
1 stars 1 forks source link
community go music mysql open-source sveltekit

The MICR ReadMe
CKM Logo!

Mario is Missing!

Go Version Twitter Follow

Project Roadmap · How to Contribute · Code of Conduct · Governance · Contributors · MICR Manifesto · Support Page · Software License

Table of contents

Prelude

Leadership & Governance

What is the MICR & Why was it created?

Roadmap / Milestones

How To Contribute

License Info

Support

Prelude
🛺

Hello, I hope you're well.

At this time a link to the web application has not been established because I need to work with my close community to establish a proper baseline for certain functions mainly around security(people's information) and authentication of instruments.

If you have any immediate questions you would like to ask and can't find a resource on this repo to help you, feel free to send an email to Micr.Support@capsulescure.io. Response time is around 24-48 hours.

 

  • If you would rather read these documents in a more traditional "book"(MD Book) style, you can read the same documents on this repo over here
  • If you are interested in seeing the 'notepad'(Notion document) I use to sketch out ideas for this project, you can visit here

 

🔹

Leadership & Governance
🛋️

Governance Document

At this time since it’s just me(Award Malisi), I will be going with the ABDFL(Alleged-Benevolent Dictator For Life) for the time being. If people join up with me on this project, I’ll definitely entertain the idea of a different leadership structure. I am more along the lines of someone who believes one should be skillful in leading and following.

CKM Logo!

 

🔹

What is The MICR & Why was it created?
❤️‍🔥

MICR Manifesto

The What:

The MICR(Musical Instrument Compendium and Registry) is a digital compendium and registry for guitars and basses(at this time), that also acts as software to assist guitarists and bassists if their instrument is ever stolen or goes missing.

 

The Why:

  • A tool for the musical community that can help forestall the thievery of a musician’s instrument or at least aid a musician if such an event were to take place
  • Once the project really get’s going I hope to fashion the project into a modular learning tool that can help software developers build and maintain an open-source full-stack application.
  • And finally, a passion project is a good way to practice a majority of my skills within computer science as well as other disciplines such as writing and graphic design. I wish to build tools for the many communities in the world and I believe this project would be a nice preface to that idea.

 

🔹

Roadmap / Milestones
🗺️

Project Roadmap

You can follow the roadmap of the project by navigating to the ‘Milestones’ page provided by Github, you can find it here.

The current milestone is for version 0.5 of the project and is titled 'My Dedication', below is the goal of the milestone:

The goal of v0.5 is to set up the infrastructure and documentation for the project so that I can then invite a select few individuals who can scrutinize the project to help it be properly structured and healthy for any contributions from the greater public, a proper start is the only way to go about things.

 

🔹

How To Contribute
🧑‍🤝‍🧑

How To Contribute Document

One of the main ideas of this project is to allow a wide range of individuals with varied skill sets to participate, below are some examples of what an individual can provide for this project. Please be sure to read the full ‘How To Contribute’ document here.

Examples of where one can see themselves contributing:

  • Ideas
  • Documentation
  • Graphic Design
  • Code
  • Bug Reports
  • Vulnerability Reports

 

🔹

License Info

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE(version 3), you can review it here I will update this section in the near future as to why I chose the GNU GPLv3 license.

🔹

The MICR Support Page
🦆

Support Doc

Please send any emails you have regarding security vulnerabilities to Micr.Support@capsulescure.io. Feel free to also use this email address if you cannot find a resource to answer your immediate question.

 

🔹