diff --git a/README.md b/README.md index 4c46d34b..808121a3 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,12 @@ The individual documentations can be found in the - `packages` folder. -If you want to contribute, you can do so with one click: +If you want to contribute, you can do get started with one click: [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/github/codesandbox/docs) +Your probably going to want to create a new fork to keep thing in sync; If you are planning to work on this a lot. +Read [here](/packages/projects-docs/pages/learn/repositories/open-source.mdx) and [here](https://codesandbox.io/blog/how-to-make-your-first-open-source-contribution) for more instructions on how to contribute. + + diff --git a/packages/projects-docs/pages/learn/repositories/open-source.mdx b/packages/projects-docs/pages/learn/repositories/open-source.mdx index 2980fa7e..24d667ee 100644 --- a/packages/projects-docs/pages/learn/repositories/open-source.mdx +++ b/packages/projects-docs/pages/learn/repositories/open-source.mdx @@ -8,11 +8,12 @@ import { Callout } from 'nextra-theme-docs' # Open Source Collaboration -Working with your favorite Open Source repositories is easier with CodeSandbox. Whether you are just checking out a repository, testing out an idea or formally proposing a feature, CodeSandbox can eliminate tedious steps in your process and get you working on your ideas faster. +Working and Contributing with your favorite Open Source repositories is easier with CodeSandbox. Whether you are just checking out a repository, testing out an idea or formally proposing a feature, CodeSandbox can eliminate tedious steps in your process and get you working on your ideas faster; In fact you may have come here after clicking +[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/github/codesandbox/docs) Button. ## Viewing Open Source repositories -Explore any open source repository through CodeSandbox simply by adding the repository's GitHub URL to the end of the CodeSandbox URL, in the format below: +To make all of this easier, we allow you to explore any open source repository through CodeSandbox simply by adding the repository's GitHub URL to the end of the CodeSandbox URL, in the format below: **`codesandbox.io/p/` `github/[org]/[reponame]`** @@ -45,4 +46,10 @@ To create a contribution branch, open the repository in the editor and click on If you try to import a repository you don't have write permission to, a new fork will be automatically created. However, during the import process, you can select the option to `Create a Contribution Branch` to start working immediately. -Your contribution branches are accessible anytime through your personal workspace in the [Dashboard](https://codesandbox.io/dashboard), under _All Repositories_. \ No newline at end of file +Your contribution branches are accessible anytime through your personal workspace in the [Dashboard](https://codesandbox.io/dashboard), under _All Repositories_ when forking and My Contributions when `Create a Contribution Branch`. + +## Fork / Create a Contribution Branch / and Branches Differences + +Branches here on CodeSandbox work just a little be differently even though they server the same purpose see [here](/learn/repositories/collaborate-share) for more info. +It is generaly recommend to use `Fork` for most project when you start +`Create a Contribution Branch` are just ment for quick fixes such as a spelling errors or one time fixes when you are not going to spend much time on them. Forks have many advatages , such as keep you code in sync with GitHub or GitLab, and with Github we will info you when a commit comes in. Since changes often come in quickly, it is often important to see who change what so you can match there style as you go.