Minerva is a markdown editor that supports real-time collaborative editing and seamless integration with GitHub. We are building Minerva by leveraging our GitHub Community. We've helped over 2.5 million developers from over 50 countries 🤯. But that's just us. We are proud to be part of the work of millions of developers, companies and robots across the solar system 🪐. Yes, Robots!
Thanks for investing the time to contribute to our project!
Read our Code of Conduct to keep our community approachable and respectable.
If you spot a problem with a given project, search if an issue already exists.
Otherwise, feel free to open a new issue. Make sure you provide a clear and detailed explaination of the issue. Provide your operating system and software version so that others can more easily replicate the issue. explanation
Scan through our repos for existing issues to find one that interests you. You can narrow down the search using labels as filters.
As a general rule, we don't assign issues to anyone. If you find an issue to work on, you are welcome to open a pull request with a fix.
-
Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
-
Install or update to Node.js v16. For more information, see the development guide.
-
Create a working branch and start with your changes!
Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.
When you're finished with the changes, create a pull request, also known as a PR.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉 The BCIT-DDC team thanks you ✨.
The open-source community is the heart of Minerva, and it acts as a milestone in how an amazing markdown editor is created with the support of people from around the world.
- Minerva has helped students attending BCIT create a professional project and profile readme(s).
- Every line of code created through the help of our collaborators has helped us grow and allow our application to be free for educational & professional use.
- We’ve helped over 100 users so far, and we’re continually growing our numbers every day.
As we expand to a larger audience, we hope to build a community of like-minded individuals that want to create something really special. We want to embrace all levels of developers to partake in a community of the brightest minds in the industry.
Additionally, we have growing communities on several platforms like Reddit, and Discord, and we’re looking to expand to other platforms too. We want people from around the world to find out about our product so that they can find a workflow that works for them.
We just want to thank everyone in the community.