h759bkyo4/Documentation
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fixed English mistakes

Browse source
This commit is contained in:
Jeremy 2022-12-17 15:32:32 +13:00 committed by Gitea
parent 9b8b8889ca
commit d42e22f64c
3 changed files with 14 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
content/git/git-ignore.md
View file

@ -6,17 +6,17 @@ eleventyNavigation:
---
You should try to keep your Git repositories small and clean of any clutter.
Only the necessary files (e.g. source files, documentation) should be committed.
This helps you in your daily work, and it helps Codeberg, as we don't have to hold large, unnecessary files.
Only the necessary files such as source files and documentation should be committed.
This helps you and it also helps Codeberg, as we don't have to hold large, unnecessary files.
Sometimes additional files are created within the same directory as your source files. These might be, for example binaries.
To prevent accidentally committing those files to your repository, you can add file and directory names to a file named `.gitignore`.
Files and directories that match the names in the `.gitignore` file are ignored by Git. They do not show up in `git status`
and they cannot be added to the staging area using `git add` (except when added with `--force`).
Files and directories that match the names in the `.gitignore` file are ignored by Git. They don't show up in `git status`
and they can't be staged for a commit using `git add` (except when using `--force`).
Gitea offers templates for `.gitignore`, for common languages when creating a repository.
Gitea has gitignore templates for many languages. These are shown when creating a repository.
## Further reading

2
content/git/squash-commits.md
View file

@ -6,7 +6,7 @@ eleventyNavigation:
order: 50
---
Sometimes you'll merge multiple commits into one. Maybe the commits are "dirty", full of non-working code or embarrassing commit messages. This solution is only one of multiple possible solutions. See this [StackOverflow question](https://stackoverflow.com/q/2563632/4865723) for more details and variants.
Sometimes you'll want to merge multiple commits into one. Maybe the commits are "dirty", full of non-working code or embarrassing commit messages. The solution shown here is only one of many possible solutions. See this [StackOverflow question](https://stackoverflow.com/q/2563632/4865723) for more details.
Here is an example.

14
content/git/using-tags.md
View file

@ -7,13 +7,13 @@ eleventyNavigation:
---
## What are tags?
Tags are a Git function used to make a snapshot of a repository. It is generally used to mark releases (e.g. v1.2.4), and it functions as a shortcut to what the repo looked like at the time.
Tags are a feature in Git that can be used to make a snapshot of a repository from a point in time. It is generally used to mark releases (e.g. v1.2.4), and it functions as a shortcut to see what the repo looked like at the time.
## What are releases?
Releases are a feature independent of Git that allows you to attach files and release notes along with the source code at the time, and share it on Codeberg, linking to a Git tag.
Releases are a feature in Gitea, independent of Git that allows you to attach files and release notes along with the source code at the time, and share it on Codeberg, linking to a Git tag.
### Wait, what is the difference between tags and releases?
They are very similar, the difference being that tags are just the repository frozen in time and are part of Git (you can make a tag inside of Git), but releases are tags accompanied with a binary file and are not part of Git (you'd need to go to your Codeberg repository page to add the binary).
They are very similar, the difference being that tags are just the repository frozen in time and are part of Git (you can make a tag inside of Git), but releases are tags accompanied with a binary file and are not part of Git (you need to go to your Codeberg repository page to create a release).
## Creating tags and releases
If you want to create tags, it's recommended to do it using Git. You can also create tags during the release creation process on Codeberg. Releases can only be created from Codeberg.
@ -23,10 +23,12 @@ If you want to create tags, it's recommended to do it using Git. You can also cr
### On Git
To create a tag using Git, use the following command in your local repository.
```bash
git tag -a <tag name, e.g., a version number> -m "<my tag message>"
git tag -a <tag name> -m "<my tag message>"
```
You can omit `"<my tag message>"` to write a longer tag message in an editor window. Tags are not automatically pushed when you run `git push` (compared to commits or branches). They have to be pushed manually to the remote target, like so:
You can omit `"<my tag message>"` to write a longer tag message in an editor window.
Tags are not automatically pushed when you run `git push` (compared to commits or branches). They have to be pushed manually to the remote target, like so:
```bash
git push --tags <remote target, probably "origin">
```
@ -60,7 +62,7 @@ You are then re-directed to the `Releases` tab of your repository. The newly cre
<img src="/assets/images/collaborating/citable-code/releases2.png" alt="releases2">
</picture>
Here, you can edit the release if needed, and you can also download the source code in ZIP or TAR.GZ format.
Here, you can edit the release if needed, and you can also download the source code in .zip or .tar.gz format.
## Finding and viewing releases in a repository
<picture>