Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.99 KB

What Do I Need To Know To Help?

If you are looking to help with WeOS, you can contribute a few ways, and not all of them require you to know how to code.

If you have a coding background, you can help with WeOS core (you will need to be familiar with Golang and set up docker for the testing toolchain). You can also help create example APIs (familiarity with the OpenAPI specification). If you are a UI developer, you can help work on micro frontends and components that use the APIs that other developers can use in their apps.

If you're not into coding (yet :) ), you can also help us out by helping improve our documentation. You can also share with us how we can improve the user experience of our applications or help spread the word about what we're trying to accomplish with WeOS.

How Do I Make A Contribution?

Decided that you want to help with code, but you've ever made an open-source contribution before? No worries, we'll help get you started

  1. Find an issue that you are interested in contributing (https://github.com/wepala/weos/issues). If one doesn't already exist for what you have in mind, go ahead and create one!
  2. Fork the repository to your account so that the project would be in your (or your organization's) account e.g. https://github.com//weos
  3. Clone the repository to your local machine using git clone
  4. Create a branch for your update
  5. Make your changes
  6. Commit your changes to your branch
  7. Push the changes to the branch you made on your local machine to your remote repository
  8. Create a Pull Request from the branch in your repository to the dev branch in the main (also called upstream) repository. We have some guidelines for creating a Pull Request
  9. Wait for the pull request to be reviewed by a maintainer.
  10. Make changes to the pull request if the reviewing maintainer recommends them.
  11. Celebrate your success after your pull request is merged!

Where Can I Go For Help?

If you need help, you can ask questions on Discord or reach us on GitHub.