rogs/yams
rogs/yams
1
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity
yams/CONTRIBUTING.org

2.8 KiB
Raw Permalink Blame History

Contributing to YAMS - Yet Another Media Server

Thank you for your interest in contributing to YAMS! We appreciate your help in making this project better.

Table of contents   toc

Getting Started

  1. Fork the Repository: Start by forking the YAMS repository on GitLab by clicking the "Fork" button at the top right of the repository page: YAMS on GitLab.

  2. Clone Your Fork: Clone your forked repository to your local development environment using Git.

    git clone https://gitlab.com/your-username/yams.git
cd yams

  3. Create a New Branch: Create a new branch for your changes. It's a good practice to name your branch descriptively.

    git checkout -b your-branch-name
  4. Make Changes: Make the necessary code changes, additions, or improvements in your branch. Ensure that your code follows our coding standards and guidelines.
  5. Test Your Changes: Test your changes to ensure they work as expected and do not introduce any new issues.

  6. Commit Your Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Your descriptive commit message"

  7. Push Your Changes: Push your branch to your forked repository on GitLab.

    git push origin your-branch-name
  8. Create a Merge Request (MR): Go to the original YAMS repository on GitLab and click on "New Merge Request." Select your branch as the source and create the MR. Provide a clear and detailed description of your changes.
  9. Review and Collaborate: Your MR will be reviewed by the project maintainers. Be prepared to address any feedback or make further improvements based on the review.
  10. Merging: Once your MR is approved, it will be merged into the YAMS project. Congratulations, you've contributed to YAMS!

Code of Conduct

Basically, don't be an asshole. You can read our Code of Conduct here: https://gitlab.com/rogs/yams/-/blob/master/CODE_OF_CONDUCT.org

Questions and Support

If you have any questions or need support while contributing to YAMS, feel free to reach out to us on our forums or our chats: Matrix / Discord

Thank you for helping make YAMS better!