---
title: "How to contribute?"
canonical: "https://onesaitplatform.refined.site/space/DOCT/2220814633/How%20to%20contribute%3F"
format: markdown
---
> Macro (toc)


## Welcome to the onesait Platform Community

As an open-source project, onesait Platform is waiting for your contributions. You can contribute to the Community in various ways.

## What fits you best?

- I want to do some examples on the platform and I want these examples to be part of the platform.
- I like to improve your documentation or event create new guides.
- I have found some bugs. What should I do?
- I have found a bug, I have the source code and I have resolved it.
- I think you need more tests. I have the time and desire to help you.
- I´d love to improve one of your modules/components.
- I need a functionality not covered by the platform but I think I can do it as a module or extension in the platform.
- I have a business case (or idea) and I think I can do it with the platform. Would you help me?


We are following the open-source standard for collaboration, so:

## Feel free to contribute to our repository on [GitHub](https://github.com/onesaitplatform)

To contribute to project on [GitHub](https://github.com/onesaitplatform/onesait-cloud-platform), read below.

## But if you think it's better to talk to us

To see how to approach the contribution, write to our mail [contributions@onesaitplatform.com](mailto:contributions@onesaitplatform.com) 

## How to contribute in Github

<span style="color: #24292e">To contribute to project on</span><span style="color: #24292e"> </span>[GitHub](https://github.com/onesaitplatform)<span style="color: #24292e">, use the</span><span style="color: #24292e"> </span>[**GitHub flow**](https://guides.github.com/introduction/flow/)**<span style="color: #24292e">.</span>**<span style="color: #24292e"> </span><span style="color: #24292e">It means that you should branch from the main repository and contribute back by making</span><span style="color: #24292e"> </span>[Pull Requests](https://help.github.com/articles/using-pull-requests/)<span style="color: #24292e">. (That is a generally accepted process flow on GitHub).</span>

To follow the instructions in this guide and start contributing to **onesait Platform **project on GitHub:

1. [**Fork**](https://help.github.com/articles/fork-a-repo/)** the **[**main repository**](https://github.com/onesaitplatform)**.**

On [https://github.com/onesaitplatform/onesait-cloud-platform](https://github.com/onesaitplatform/onesait-cloud-platform) select

![image](media://27d7707f-6433-4652-b577-795b05d2d3c4)

1. [**Clone**](https://help.github.com/articles/cloning-a-repository/)** your new repository.**

To do this, run the following command.

<span style="color: #0000ff">git clone </span>[<span style="color: #0000ff">https://github.com/</span>](https://github.com/lmgracia/onesait-cloud-platform)<span style="color: #0000ff">[<your_github_name>](https://github.com/lmgracia/onesait-cloud-platform)</span>[<span style="color: #0000ff">/onesait-cloud-platform</span>](https://github.com/lmgracia/onesait-cloud-platform)<span style="color: #0000ff">   </span><span style="color: #0000ff">#</span><span style="color: #0000ff"> Replace <your_github_name> with your GitHub profile name.</span><span style="color: #0000ff"> </span>

<span style="color: #0000ff">cd</span><span style="color: #0000ff"> onesait-cloud-platform</span>

![image](media://4a55ae1d-e1b4-48af-a395-0f581cfe2b9e)

3**. To synchronize with the main repository, add it to the remotes:**

<span style="color: #0000ff">git remote add upstream </span>[<span style="color: #0000ff">https://github.com/onesaitplatform/onesait-cloud-platform.git</span>](https://github.com/onesaitplatform/onesait-cloud-platform.git)<span style="color: #0000ff"> </span>


<span style="color: #24292e">Now your</span><span style="color: #24292e"> </span>**upstream**<span style="color: #24292e"> </span><span style="color: #24292e">points to</span><span style="color: #24292e"> </span>**<span style="color: #24292e">onesaitplatform</span>****/onesait-cloud-tplatform**<span style="color: #24292e">.</span>

### Branches

The **master** branch represents the latest development version of onesait Platform.

![image](media://578c19f0-e7e2-4a32-9706-7c89e85a7e2a)

Most changes should go there.

The **release-x.x** branches are used as stabilizing branches for maintenance releases. 

If you want to backport a bug fix, open your pull request (PR) against the appropriate release branch.

### Merge requirements

Resolve any merge conflicts that may arise. If conflict occurs, a corresponding message will be displayed on the PR page on GitHub.

To resolve a conflict, run the following commands:


`# checkout a branch you open PR from``
`

`git fetch upstream ``# assuming upstream is ``onesaitplatform``/onesait-cloud-platform``.``
`

`git merge upstream/merge_branch ``# Where merge_branch is a branch you open PR against.``
``# resolve pull requests``
`

`git add *
`

`git commit
`

`git push`

GitHub will automatically update your pull request.

### Testing

All the pull requests will be automatically tested using [Jenkins](https://jenkins.io/). If some tests fail, fix the issues or describe why the fix cannot be done.

### Review

The assigned team members review every pull request as per standard [GitHub procedure](https://help.github.com/articles/about-pull-request-reviews/). Reviewers can comment on a PR, approve it, or request changes to it. A PR can be merged when it is approved by at least two assigned reviewers and has no pending requests for changes.

### Gatekeepers

A gatekeeper is a person responsible for the final review and merge. They are also responsible for managing Git repositories. Only gatekeepers can write to **master** and **release** branches.



> Macro (__confluenceADFMigrationUnsupportedContentInternalExtension__)