Skip to content

Commit

Permalink
doc(guide): new 'Creating Your Project' chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
julien-deramond committed Oct 14, 2023
1 parent bddbc07 commit bca6ab4
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: 4
id: 5
title: 'Building and Engaging Your Community'
metaDescription: ""
soon: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: 5
id: 6
title: 'Contributing Your Project to the Open Source Community'
metaDescription: ""
soon: true
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: 3
title: 'Creating Your Project'
metaDescription: "Ready to bring your Open Source project idea to life? Learn to create a project repository on GitHub or GitLab and start shaping your impact on the Open Source world."
creationDate: '2023-10-14'
lastUpdateDate: '2023-10-14'
---
<p class="lead">So you've got a fantastic Open Source project idea, you've planned it out meticulously, or maybe you're just getting started. Either way, you're ready to bring it to life. In this chapter, we'll dive into the nitty-gritty of **creating your Open Source project**. It's the moment where you get to shape your idea into reality and start making a meaningful impact on the Open Source world. Here's your step-by-step guide to kickstart your project.</p>

## Setting Up a Repository

A proper project repository is the heart of your Open Source project. Whether you host it on GitHub, GitLab, or any other platform, it's the place where you'll story your project content (source code, documentation, data, etc.), and where you'll collaborate with other contributors. It's also the place where you'll manage your project's issues and contributions, and where you'll publish your project's releases.

### Choosing a Repository Hosting Platform

There are many different [source code hosting platforms](/guide/getting-started-with-open-source/source-code-hosting-platforms) that you can use to host your project repository. The most popular ones are GitHub and GitLab. Each platform has its own advantages and disadvantages, so it's important to choose the one that best suits your needs.

### Creating a Profile

The first step to creating your project repository is to create a profile on your chosen hosting platform. This is where you'll manage your project and collaborate with other contributors. You can create a profile on GitHub, or GitLab by following the instructions on their respective websites.

* <a href="https://docs.github.com/en/get-started/signing-up-for-github" target="_blank" rel="noopener">Signing up for a new GitHub account</a>
* <a href="https://docs.gitlab.com/ee/subscriptions/gitlab_com/index.html" target="_blank" rel="noopener">Signing up for a new GitLab account</a>

### Creating an Organization

This step is optional, you can start by creating a repository under your personal profile, and then move it to an organization later on.

Creating an organization allows you to manage multiple projects under a single umbrella, and it also allows you to grant access to other contributors. You can create an organization on GitHub, or GitLab by following the instructions on their respective websites.

* <a href="https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations" target="_blank" rel="noopener">Create an organization on GitHub</a>
* <a href="https://docs.gitlab.com/ee/topics/set_up_organization.html" target="_blank" rel="noopener">Create an organization on GitLab</a>

### Creating a Repository

Within an organization or your profile profile, you can now create your project. GitHub names them repositories or repos, while GitLab names them projects; but they're essentially the same thing. You can create a repository on GitHub, or a project on GitLab by following the instructions on their respective websites.

* <a href="https://docs.github.com/en/get-started/quickstart/create-a-repo" target="_blank" rel="noopener">Create a repo on GitHub</a>
* <a href="https://docs.gitlab.com/ee/user/project/organize_work_with_projects.html" target="_blank" rel="noopener">Create a project on GitLab</a>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: 3
id: 4
title: 'Developing Your Project'
metaDescription: ""
soon: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: 6
id: 7
title: 'Legal Considerations'
metaDescription: ""
soon: true
Expand Down

1 comment on commit bca6ab4

@vercel
Copy link

@vercel vercel bot commented on bca6ab4 Oct 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.