Contributing Guidelines
How to contribute ?
A big welcome and thank you for considering contributing to Mumble! It’s people like you that make it a reality for users in our community.
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
Also if you are looking for a complete style guides, please refer to Style Guidelines We highly recommend to go through the guideline before start contributing.
⚠ Those who wants to contribute on the repo, from now, before pushing/committing your changes, please make sure you run command
npm run format
oryarn format
or use Prettier plugin to automatically format your code. We want to maintain consistency that's why we want to enforce the formatting. It's required!
Table of contents
Contributing to Mumble
Code of Conduct
Getting Started
Issues
Pull Requests
Merging PRs
Project board
Reviewers
NB
Fork-and-Pull
Minor Updates
Getting Help
Code of Conduct
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
Getting Started
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
To report security vulnerabilities, please send a message in our discord server Join here.
Search for existing Issues and PRs before creating your own.
We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
If you've never contributed before, see the first timer's guide on Auth0 blog for resources and tips on how to get started.
Issues
Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created.
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
Pull Requests
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
Address a single concern in the least number of changed lines as possible.
Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
Tag 2 Reviewers !
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
Merging Pull Requests
It's mandatory that the PR author adds reviewers prior to submitting the PR. Tag reviewers in the message. A collaborator of the repo will officially add them in PR as reviewer(s).
All PRs will require the approval of both reviewers prior to the branch merge. Once the last reviewer approves the changes, they can merge the branch.
The PR author should add two reviewers; unless the change is so minor (think documentation, code formatting). A collaborator will choose a label "Review: Needs 1" OR "Review: Needs 2" to further organize the repo and review system.
Project Board
In our repository, there is a project board named Tasks - Mumble, it helps moderators to see how is the work going.
Reviewers :
After submitting your PR, please tag reviewer(s) in your PR message. You can tag anyone below for the following.
Markdown, Documentation changes :
Request @Mehdi - MidouWebDev's review !
Frontend, Design :
--> Choose two reviewers :
Fork & Pull
In general, we follow the fork-and-pull
Steps :
1. Fork the repository to your own Github account
2. Clone the forked project to your machine
3. Add Upstream or the remote of the original project to your local repository
4. Make sure you update the local repository
5. Create a branch locally with a succinct but descriptive name
6. Commit changes to the branch
7. Following any formatting and testing guidelines specific to this repository
8. Push changes to your fork
9. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
10. After the pull request was merged, fetch the upstream and update the default branch of your fork
You can follow along with this video, Contributing to Mumble
NB
You have to install Git for your operating system
Never Commit on the default branch, commit on branches then make a pull request
After making changes, if you want to make another change make sure you branch from the default branch because if you branch from branch-name, this will contain the changes from the 1st pull request except for the new pull request you working on requires the changes from the first pull request
After the pull request was merged, fetch it and update the master branch of your fork
Minor Updates and Pull Requests
It is advisable, to combine all minor updates in a single pull request to reduce the number of pull requests.
Check for a list of minor updates in the Issues as shown in the image.
Make changes and commit accordingly
Create a pull request and wait for review
Once your pull request has been merge, make sure to update your master branch.
Getting Help
Join us in the Discord Server and post your question there in the correct category with a descriptive tag.
Last updated