From bca6ab4bba26c8cd4c179c22f8e2dc3a4b8ca5a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20D=C3=A9ramond?= Date: Sat, 14 Oct 2023 23:11:27 +0200 Subject: [PATCH] doc(guide): new 'Creating Your Project' chapter --- .../building-and-engaging-your-community.mdx | 2 +- ...r-project-to-the-open-source-community.mdx | 2 +- .../creating-your-project.mdx | 39 +++++++++++++++++++ .../developing-your-project.mdx | 2 +- .../legal-considerations.mdx | 2 +- 5 files changed, 43 insertions(+), 4 deletions(-) create mode 100644 src/content/modules/creating-your-own-open-source-project/creating-your-project.mdx diff --git a/src/content/modules/creating-your-own-open-source-project/building-and-engaging-your-community.mdx b/src/content/modules/creating-your-own-open-source-project/building-and-engaging-your-community.mdx index fe75d073..7cd84123 100644 --- a/src/content/modules/creating-your-own-open-source-project/building-and-engaging-your-community.mdx +++ b/src/content/modules/creating-your-own-open-source-project/building-and-engaging-your-community.mdx @@ -1,5 +1,5 @@ --- -id: 4 +id: 5 title: 'Building and Engaging Your Community' metaDescription: "" soon: true diff --git a/src/content/modules/creating-your-own-open-source-project/contributing-your-project-to-the-open-source-community.mdx b/src/content/modules/creating-your-own-open-source-project/contributing-your-project-to-the-open-source-community.mdx index 2a79e130..681442de 100644 --- a/src/content/modules/creating-your-own-open-source-project/contributing-your-project-to-the-open-source-community.mdx +++ b/src/content/modules/creating-your-own-open-source-project/contributing-your-project-to-the-open-source-community.mdx @@ -1,5 +1,5 @@ --- -id: 5 +id: 6 title: 'Contributing Your Project to the Open Source Community' metaDescription: "" soon: true diff --git a/src/content/modules/creating-your-own-open-source-project/creating-your-project.mdx b/src/content/modules/creating-your-own-open-source-project/creating-your-project.mdx new file mode 100644 index 00000000..0464be8c --- /dev/null +++ b/src/content/modules/creating-your-own-open-source-project/creating-your-project.mdx @@ -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' +--- +

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.

+ +## 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. + +* Signing up for a new GitHub account +* Signing up for a new GitLab account + +### 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. + +* Create an organization on GitHub +* Create an organization on GitLab + +### 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. + +* Create a repo on GitHub +* Create a project on GitLab diff --git a/src/content/modules/creating-your-own-open-source-project/developing-your-project.mdx b/src/content/modules/creating-your-own-open-source-project/developing-your-project.mdx index 06c24e04..04554cf2 100644 --- a/src/content/modules/creating-your-own-open-source-project/developing-your-project.mdx +++ b/src/content/modules/creating-your-own-open-source-project/developing-your-project.mdx @@ -1,5 +1,5 @@ --- -id: 3 +id: 4 title: 'Developing Your Project' metaDescription: "" soon: true diff --git a/src/content/modules/creating-your-own-open-source-project/legal-considerations.mdx b/src/content/modules/creating-your-own-open-source-project/legal-considerations.mdx index 3e2c535d..4f18e645 100644 --- a/src/content/modules/creating-your-own-open-source-project/legal-considerations.mdx +++ b/src/content/modules/creating-your-own-open-source-project/legal-considerations.mdx @@ -1,5 +1,5 @@ --- -id: 6 +id: 7 title: 'Legal Considerations' metaDescription: "" soon: true