Getting-started; some grammar and typos
This commit is contained in:
Martijn de Boer
parent
f77ba56974
commit
db1995d687
5 changed files with 24 additions and 24 deletions
|
|
@ -6,16 +6,16 @@ eleventyNavigation:
|
|||
order: 30
|
||||
---
|
||||
|
||||
Almost everything you can do on Codeberg starts in a repository. Think of a repository as a home for your project, where all of its sourcecode can be organized using Git and which also contains optional features like an issue tracker and wiki.
|
||||
Almost everything you can do on Codeberg starts in a repository. Think of a repository as a home for your project, where all of its source code can be organized using Git and which also contains optional features like an issue tracker and wiki.
|
||||
|
||||
This article will lead you through creating your first repository on Codeberg, connecting your local development environment and making your first sourcecode commit.
|
||||
This article will lead you through creating your first repository on Codeberg, connecting your local development environment and making your first source code commit.
|
||||
|
||||
## Creating a Repository
|
||||
> A note to more advanced users: It is currently not possible to use Push-to-Create to push a fresh repository onto Codeberg.
|
||||
|
||||
To create a new repository, you need be logged in to your account on Codeberg.org.
|
||||
|
||||
After login you can use one of the two buttons shown in the two following screenshots to create a new repository:
|
||||
After login, you can use one of the two buttons shown in the two following screenshots to create a new repository:
|
||||
|
||||
<picture>
|
||||
<source srcset="/assets/images/getting-started/first-repository/create-repo.webp" type="image/webp">
|
||||
|
|
@ -123,7 +123,7 @@ LICENSE README.md
|
|||
If you already have written source code that you now would like to upload to Codeberg, follow these steps:
|
||||
|
||||
#### 1. Initialize a Git Repository
|
||||
Do this first, unless you already have a Git Repository initializied in your local source tree:
|
||||
Do this first, unless you already have a Git Repository initialized in your local source tree:
|
||||
|
||||
```bash
|
||||
knut@iceberg:~/my-project$ git init
|
||||
|
|
@ -131,7 +131,7 @@ Initialized empty Git repository in /home/knut/my-project/.git/
|
|||
```
|
||||
|
||||
#### 2. Add Codeberg as the repository's origin
|
||||
Now, you need to tell Git where to push your changes to. You do that by specifying Codeberg as a remote.
|
||||
Now, you need to tell Git where to push your changes. You do that by specifying Codeberg as a remote.
|
||||
|
||||
> In this example, we'll specify Codeberg as the `origin` remote. You can name your remote any other way, especially if you already have an `origin`, but `origin` is the recommended name for the main remote repository.
|
||||
|
||||
|
|
@ -152,7 +152,7 @@ Now that you've connected your repository to your local development copy, it is
|
|||
Let's modify the auto-generated `README.md` file.
|
||||
|
||||
> If you haven't auto-generated `README.md`, the following commands will still work fine, but create a new file containing only `Hello World!` instead
|
||||
|
||||
|
||||
```bash
|
||||
knut@iceberg:~/repositories/foobar$ echo "Hello World!" >> README.md
|
||||
knut@iceberg:~/repositories/foobar$ cat README.md
|
||||
|
|
@ -225,7 +225,7 @@ If you're happy with the changes you made, the next step is to present them to t
|
|||
```bash
|
||||
knut@iceberg:~/repositories/foobar$ git push -u origin main
|
||||
Username for 'https://codeberg.org': knut
|
||||
Password for 'https://knut@codeberg.org':
|
||||
Password for 'https://knut@codeberg.org':
|
||||
Enumerating objects: 5, done.
|
||||
Counting objects: 100% (5/5), done.
|
||||
Delta compression using up to 16 threads
|
||||
|
|
|
|||
|
|
@ -12,18 +12,18 @@ and click on "Register" to bring up the registration form.
|
|||
|
||||
There, simply fill in your username and email address and then choose a good password.
|
||||
|
||||
After confirming your email address by clicking the link that we sent you to your
|
||||
After confirming your email address by clicking the link that we sent you to your
|
||||
email account, you're done and good to go!
|
||||
|
||||
|
||||
## Community
|
||||
Codeberg is a non-profit volunteer effort. It relies on its friendly and dedicated community. We're happy that you're now a part of our community, too, and we hope you're feeling welcome!
|
||||
|
||||
We kindly ask you to be polite and civil when on Codeberg and to not excessively use the resources provided. Please see our [Terms of Use](https://codeberg.org/codeberg/org/src/branch/master/TermsOfUse.md) for details.
|
||||
We kindly ask you to be polite and civil when on Codeberg and to not excessively use the resources provided. Please see our [Terms of Use](https://codeberg.org/codeberg/org/src/branch/master/TermsOfUse.md) for details.
|
||||
|
||||
Please remember that everyone here is contributing on their free time, as volunteers.
|
||||
|
||||
If you like a project on Codeberg, consider **giving it a star** and/or **following its author**. That helps building and growing a network of free software projects and people and can serve as guidance for users exploring Codeberg, looking for interesting projects to try out or contribute to.
|
||||
If you like a project on Codeberg, consider **giving it a star** and/or **following its author**. That helps with building and growing a network of free software projects and people and can serve as guidance for users exploring Codeberg, looking for interesting projects to try out or contribute to.
|
||||
|
||||
|
||||
## Orienting yourself on Codeberg
|
||||
|
|
@ -37,7 +37,7 @@ After successfully registering on Codeberg, you should see this screen:
|
|||
An explanation of the highlighted elements above:
|
||||
|
||||
- **Dashboard (1)** is the screen you're looking at right now. It gives you an overview of the newest activity
|
||||
of you, the people you follow and in your or your organization's projects.
|
||||
by you, the people you follow and in your or your organization's projects.
|
||||
- **Issues (2)** and **Pull Requests (3)** These are overviews of issues and pull requests that you are either involved in or that are part of one of the organizations you belong to.
|
||||
- **Codeberg Issues (4)** This is currently the primary communication channel for the Codeberg Community. Here, you can ask questions, report bugs and suggest changes to Codeberg. You're also welcome to browse these issues and contribute your solutions, if you want to support Codeberg even more.
|
||||
- **The Create Menu (5)** You can create repositories, organizations and migrations using this menu. It's your entry point to kicking off entirely new things on Codeberg.
|
||||
|
|
@ -48,7 +48,7 @@ An explanation of the highlighted elements above:
|
|||
## A word about Security
|
||||
While it is important to choose a strong password, it is also
|
||||
important to use Two-factor Authentication in case your password or device
|
||||
ever gets compromised, so that should be one of the first things to
|
||||
ever gets compromised, so that should be one of the first things to
|
||||
configure after you have created your account.
|
||||
|
||||
We recommend that you use Two-factor Authentication on your account, to increase
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ eleventyNavigation:
|
|||
order: 25
|
||||
---
|
||||
|
||||
Projects on Codeberg use [Git](https://git-scm.com/) as their [version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) system. If you want to contribute sourcecode, it is a good idea to install Git at this point.
|
||||
Projects on Codeberg use [Git](https://git-scm.com/) as their [version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) system. If you want to contribute source code, it is a good idea to install Git at this point.
|
||||
|
||||
Git runs on every OS. You can download it directly from the [Git website](https://git-scm.com/downloads), or from your operating system’s package manager (if available).
|
||||
|
||||
|
|
@ -99,4 +99,4 @@ If you want to keep all your settings, simply tick the box `Only show new option
|
|||
<a name="git-clients"></a>
|
||||
## Git clients
|
||||
Git can be used from the command line as shown above, but it can also be used through graphical user interfaces called *Git clients*.
|
||||
You can find a list of some of the available Git clients on the [Git website](https://git-scm.com/downloads/guis).
|
||||
You can find a list of some available Git clients on the [Git website](https://git-scm.com/downloads/guis).
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ direction, ask questions and much more.
|
|||
|
||||
You can find the issue tracker of a project by clicking its "Issues" tab (1).
|
||||
|
||||
There, you will see browseable and filterable (2) list of all issues.
|
||||
There, you will see browsable and filterable (2) list of all issues.
|
||||
Many projects use labels to categorize issues. A good label to look for, if you want
|
||||
to contribute to a project is the "help wanted" label.
|
||||
|
||||
|
|
@ -28,13 +28,13 @@ You can switch between issues that are still open, and those that are already re
|
|||
Some projects define milestones (4), to which issues can be assigned. They are good for
|
||||
visualizing the high-level progress of a project's development.
|
||||
|
||||
You can create an issue by clicking on the green "New Issue" button (5) at the top left
|
||||
You can create an issue by clicking on the green "New Issue" button (5) at the top left
|
||||
of the issues list.
|
||||
|
||||
Issues in the issue tracker are public and everyone is able to read and answer to them.
|
||||
|
||||
An Issue can have an assignee, meaning someone responsible for resolving or moderating
|
||||
the issue. Their profile picture, with a link to their profile, can be seen in the issue
|
||||
the issue. Their profile picture, with a link to their profile, can be seen in the issue
|
||||
list.
|
||||
|
||||
### Life of an Issue
|
||||
|
|
@ -45,8 +45,8 @@ strictly defined, based on the project you're contributing to.
|
|||
The first thing that might happen is that your issue is categorized using labels.
|
||||
Your issue may be reviewed by the project's maintainer(s) and evaluated whether it i.e. might be a duplicate or an invalid bug report.
|
||||
|
||||
Then, depending on what kind of issue it is, there might be a additional questions
|
||||
or a discussion and, if applicable, the implementation of a solution (or the rejection of
|
||||
Then, depending on what kind of issue it is, there might be additional questions
|
||||
or a discussion and, if applicable, the implementation of a solution (or the rejection of
|
||||
the issue).
|
||||
|
||||
Finally, the issue is closed, thus vanishing from the list of open issues.
|
||||
|
|
@ -54,7 +54,7 @@ Issues might have dependencies on other issues or pull requests preventing them
|
|||
|
||||
Occasionally, issues might become stale. That's when there hasn't been any progress for
|
||||
an extended period of time (usually months). You might consider reviving these, if there
|
||||
is a strong interest in getting them resolved (and, preferably, if you can contribute
|
||||
is a strong interest in getting them resolved (and, preferably, if you can contribute
|
||||
something to them).
|
||||
|
||||
> If you encounter an abandoned project and there is no way to contact the maintainer(s),
|
||||
|
|
@ -63,11 +63,11 @@ something to them).
|
|||
### Things to consider
|
||||
#### Security bugs
|
||||
If the bug you have found has security implications, **do not create
|
||||
an issue right away!**. Instead try contacting the project's maintainers privately.
|
||||
an issue right away!** Instead try contacting the project's maintainers privately.
|
||||
Many projects have a dedicated e-mail-address for reporting security bugs. If the
|
||||
project in question doesn't, consider writing an email directly to the project's
|
||||
project in question doesn't, consider writing an email directly to the project's
|
||||
maintainer or ask for the address in the issue tracker.
|
||||
|
||||
|
||||
> **⚠** What's important is that you **don't publicly expose security bugs before they are
|
||||
> fixed *and* the fixes are deployed** because **otherwise you might put the users of that
|
||||
> project at severe risk**.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ by Codeberg e.V. and centered around Codeberg.org, a Gitea-based software forge.
|
|||
|
||||
On Codeberg you can develop your own [Free Software](https://simple.wikipedia.org/wiki/Free_software) projects, contribute to other
|
||||
projects, [browse](https://codeberg.org/explore) through inspiring and useful
|
||||
free software, share your knowledge or build your projects a home in the web
|
||||
free software, share your knowledge or build your projects a home on the web
|
||||
using [Codeberg Pages](/codeberg-pages), just to name a few.
|
||||
|
||||
Codeberg is not a corporation but a community of free software enthusiasts providing
|
||||
|
|
|
|||
Loading…
Reference in a new issue