Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.71 KB
Raw

Contributing to LobbyHeads

:Wave: Hello there! We wholeheartedly welcome all contributions to LobbyHeads and are excited to know you are considering making one.

To ensure a robust and ideal solution, we recommend going through this guide. Following this guide saves both your time, and some of our core contributors are engaged in maintaining the project and reviewing proposals.

Submitting Bug Reports and Feature Requests

  • Before submitting a bug report or a feature request, please ensure you've done a thorough search on our Issues tab to ensure it wasn't previously reported or requested.

  • Our issue template is designed to guide you in submitting a detailed report, which helps us greatly in understanding, recreating, and addressing the issue.

  • For feature proposals, kindly submit them under our Issues tab using the enhancement tag. Describe the feature, specifying why you think it is beneficial. It would be great if you could elaborate on its expected behavior.

Sending a Pull Request

  1. For significant changes, open an issue for discussion before starting your work.

  2. Fork the repository to your account.

  3. Clone the repository:

    git clone https://github.com/your-username/LobbyHeads.git

  4. Create a new branch:

    git checkout -b name-your-branch-here

  5. Make the necessary changes/additions in the code.

  6. Commit the changes:

    git commit -m "Add a detailed commit message here"

  7. Push the code back to the repository:

    git push origin name-your-branch-here

  8. Open a pull request (PR) against the master branch of our repository. Describe your changes, why you believe they are necessary, and how they improve the project. Additionally, reference any related issues.

  9. Our maintainers will review your PR. We might suggest some changes, improvements or reasoning on why the changes should be/not being made.

Remember, to code reviews function as a quality control and learning opportunity. Be receptive to the suggestions made and committed to making the suggested improvements.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Getting Help

If you need help with making a contribution or using our project, please feel free to ask on our Discord server. We are always happy to assist those who show an endeavor to learn!

Thank you once again for your interest in contributing to LobbyHeads and making our project even better!