Skip to content

Latest commit

 

History

History
85 lines (49 loc) · 7.49 KB

CONTRIBUTING.md

File metadata and controls

85 lines (49 loc) · 7.49 KB
Raw

Welcome to Ethora contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected in this repository, once accepted ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Ethora Foundation

Currently Ethora codebase is managed by Ethora Foundation which is governed by Dappros (Dappros Ltd, company number 11455432, registered in England and Wales) and DeepX (Covijn Ltd, company number 10256693, registered in England and Wales). You may contact Ethora Foundation via https://www.dappros.com/contact-us/

License and distribution of Ethora code including your contributions

Check our license https://github.com/dappros/ethora/blob/main/LICENSE to make sure you understand how Ethora engine is distributed and that you are fine with your work being distributed this way. Do not contribute any work which you don't want to be distributed.

Please note that the company running this project (Dappros) and RTC infrastructure (DeepX) may be in some cases distributing this product (Ethora) under a commercial license to enterprise customers. This is done in order to help finance this project's R&D. Please do not make code, documentation or other project contributions in cases where you are not happy for them to be included into our commercial versions too. Please do not make code, documentation or other project contributions in cases where you would like to retain or claim any intellectual property ownership over such contributions or other parts of the project. In case you would like to restrict your contribution solely to the open source branch of the project or in case you have any other concerns around these matters, please contact us first https://www.dappros.com/contact-us/ to discuss this prior to your contribution. We are open in the future to maintain two versions of the product, an open-source and closed sourced one, or simply maintain the open-source one only, once this becomes practical. At the moment (August 2023) this isn't practical as we don't receive funding for the open source project maintenance and we don't recieve any significant code contributions from the open source community outside of our team. As soon as this situation changes we'll be happy to refine the approach on contributions accordingly.

Copyright assignment

!IMPORTANT - PLEASE MAKE SURE YOU AGREE WITH THE COPYRIGHT ASSIGNMENT WHEN CONTRIBUTING ANY CODE TO ETHORA CODEBASE!

Due to the reasons stated above and in order to allow Ethora Foundation to govern the project efficiently, we require all contributors to assign copyright in their contributions over to Ethora Foundation. By submitting your code to Ethora effectively you are gifting the full rights over that contribution, to Ethora Foundation. This way the codebase of Ethora becomes a solid codebase free from any copyright issues, conflicts or claims and Ethora Foundation can maintain it efficiently including allowing other contributors to work on evolving or improving your contributed code, licensing the whole codebase under the same license etc. Some of the reasoning why copyright assingment is needed can be found in famous open source projects such as here: https://www.gnu.org/licenses/why-assign and https://www.fsf.org/bulletin/2014/spring/copyright-assignment-at-the-fsf.

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

  1. Fork the repository.

  1. Install or update the relant development environment (for example, your favourite React Native or React.js IDE).

  2. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The GitHub team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the GitHub docs.

Now that you are part of the Ethora project community, see how else you can contribute to the docs.