Skip to content

Latest commit

 

History

History
138 lines (100 loc) · 8.41 KB

CONTRIBUTING.md

File metadata and controls

138 lines (100 loc) · 8.41 KB
Raw

How to Contribute

👍 First off, thank you for contributing to Planet Lia. It's awesome people like you that make our journey worthwhile!

New to contributing to Open Source? Don't be scared by the length of this guide, we know you are already experienced enough to contribute and we really need your help! 😄 Feel free to ask questions, everyone is a beginner at first.

Following this guidelines will make it easier for the maintainers of the project to better understand your contribution, help you write a more consistent code with the project and make it much more likely that it will be accepted and merged into the project.

All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly.

Table of contents:

Finding Things to Work On

The first place to start is to search through the issues in the repository. Search for issues labeld with good first issue and help wanted. Find something that you think you can complete and comment below the issue that you would like to work on it. Once you get a green light you are ready to dig in.

Of course, feel free to submit a new issue if you think something needs to be added or fixed.

Bug Report 🐛 or Feature Request 🌟?

  1. Bug Reports

    ⚠️ Security issue - if you find a security vulnerability, do NOT open an issue. Email [email protected] instead. This will prevent making the vulnerability public where someone might abuse it.

    If you find a bug in our code you can submit a bug report. Please follow the template guidelines and provide as many details as possible.

  2. Feature Requests

    Here you can submit a feature request. Please follow the template guidelines and provide as many details as possible.

    If a feature is related to a specific game and not directly to the Planet Lia platform, please use a section in our Forum dedicated to that game.

    Note that some feature request might be out of scope or not aligned with the goals of the project and might not be accepted. Even if that happens we are very happy that you submitted your request and don't be discouraged to open another one when new idea pops into your mind.

Improve Documentation 📕

We have large amounts of documentation that take a lot of time and effort for us to write and curate. Any help with it is greatly appreciated.

Some ideas where you can help:

  • fixing typos, spelling & grammar
  • fixing inconsistencies throughout the code
  • fixing outdated information
  • adding new content in form of context clarifications, adding tutorials or new documentation sections

⚠️ Adding new content - if you will be adding new content please first open an issue with the changes you have in mind so that we can discuss them and see if they align with the goals of the project.

A few documentation pages that you can help us with:

Contribute Code 🔧

NOTE - We are following a standard contributing workflow for GitHub open source projects. You can check this free video series for more details on the workflow used below, How to Contribute to an Open Source Project on GitHub, or you can read a shorter written version by freeCodeCamp.

How to contribute code:

  1. Fork this repository
  2. Clone your fork
    • git clone <SSH_OR_HTTPS_LINK_TO_YOUR_FORK>
  3. Follow changes in original repo
    • git remote add upstream https://github.com/planet-lia/planet-lia
    • git branch --set-upstream-to=upstream/master
  4. Configure git hooks that will automatically check the quality of your commit message
    • git config core.hooksPath .githooks
  5. Decide what to work on
    • 🔶 Fix existing issue but first let others know that you are working on it by commenting on that issue
    • 🔶 Open a new issue with a suggested change and wait for it to be approved
    • 🔶 Contribute small changes where you don't need to create an issue before starting to code. As a rule of thumb, a small changes are the ones that introduce obvious fixes and don't introduce new functionality. Some examples might be spelling / grammar fixes, typos, bad formatting, improving clarity in documentation, improvement to error code messages, etc..
  6. Create a new branch with a name relevant to the change you are making
    • git checkout -b <NAME_OF_YOUR_BRANCH>
  7. Implement your changes
    • Make sure to write test when appropriate
    • Make sure all tests run successfully
  8. Commit your changes
  9. Push changes to your fork
    • git push origin <NAME_OF_YOUR_BRANCH>
  10. Create a pull request to planet-lia:master through GitHub website
  11. Iterate your solution until accepted
    • If maintainers request additional changes simply implement them in your local branch, push it again to master and the pull request will get updated automatically
  12. Get merged to Planet Lia repo! ✔️
  13. Delete your local branch
    • git checkout master
    • git branch -D <NAME_OF_YOUR_BRANCH>
  14. To start working on new feature
    • git pull origin master
    • Jump back to step 5

Here is a great collection of useful git tricks to help you use git more efficiently.

What We Don't Accept

This are a few reasons why your pull request might get rejected:

  • Cosmetic style changes to existing code which sole purpose is to make the code look more beautiful and don't improve any functionality. Code style tastes differ from person to person, stick with a style that the project is already using.
  • Pull requests that don't follow the style guide of the project.
  • Pull requests that are not trivial and don't refer to any previously opened issue and/or that the issue they refer to was rejected.

Style Guide

Each sub-project in Planet Lia platform has its own style depending on the language and the frameworks used. Before you start writing code skim through other parts of the project that you will work on and use the style that you find there.

A few important style conventions that you need to consider:

  • naming variables (variable_name vs. variableName)
  • naming files (MyWorker.xy vs. myWorker.xy vs. my_worker.xy)
  • spacing (2 vs. 4 spaces vs. tabs)
  • brackets and formating (curly braces positions, line wrapping)
  • writing test when appropriate
  • adding comments to your code
  • documenting your changes in project specific docs (usually README.md within the project)
  • Golang - before commiting use go fmt command to format your code
  • Markdown - put every sentence in a new line as it helps a ton when reviewing changes with git diff

Commit Messages

Check our Commit Message Guidelines for more details.

Thanks for contributing! ❤️❤️

Planet Lia Team