Plasmo Voice

Plasmo Voice

2M Downloads

[Document Request] Add CONTRIBUTING.md

sya-ri opened this issue ยท 2 comments

commented

I think Plasma Voice Chat is a great project. And I want it to be even better than it is now. So I want to work on language support and bug fixes. However, the branch structure is confusing and I don't know from which branch to create the branch.

Would you please document how to contribute and how to explain the branch? Thank you.

commented

Thank you for showing interest in contributing to the project. We are working on restructuring the project, combining Forge and Fabric into one branch, so I hope that this will make it less confusing. I think that it's going to be uploaded to GitHub today or tomorrow.

There will be the main branch containing Forge and Fabric mods for 1.17, the second one with Forge and Fabric mods for 1.16, and also the third one for the Spigot plugin.

I'm not sure about what you mean by adding CONTRIBUTING.md though. This is our first time creating an open-source project like this, so we don't have much experience in doing it right. Can you clarify, what exactly needs to be mentioned in this file?

commented

Sounds good. The integration between branches using multi-projects is great. I'm looking forward.

CONTRIBUTING.md is where you can write information for developers and contributors to understand this project. For example:

  • Build a project
  • Branch and directory structure
  • Commit message template
  • Pull Request
  • Other rules, ...

This information is for people who "develop" it, not people who "use", so you write a detailed explanation according to this project. Thank you and your wonderful project.