Zergling_man/moment
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs after dev branch got deleted

Browse Source
This commit is contained in:
DrRac27
2022-09-13 18:40:42 +02:00
parent 4c3a8444c6
commit 966f0965f9
2 changed files with 8 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/CONTRIBUTING.md
View File

@@ -33,27 +33,19 @@ For changes outside of simple bug/typo/formatting fixes, it is strongly
recommended to first discuss your ideas in a related issue or in recommended to first discuss your ideas in a related issue or in
[#moment-client:matrix.org](https://matrix.to/#/%23moment-client:matrix.org). [#moment-client:matrix.org](https://matrix.to/#/%23moment-client:matrix.org).
New changes are merged to the
[`dev` branch](https://gitlab.com/mx-moment/moment/-/tree/dev) first.
Once a new version of the application is released,
the current `dev` is merged into the main `main` branch.
By sending your changes, you agree to license them under the LGPL 3.0 or later. By sending your changes, you agree to license them under the LGPL 3.0 or later.
### Procedure ### Procedure
Start by forking the main repository from GitLab, then Start by forking the main repository from GitLab, then
clone your fork and switch to a new branch based on `dev`, in which clone your fork where you will make your changes:
you will make your changes:
```sh ```sh
git clone --recursive https://gitlab.com/yourUsername/moment git clone --recursive https://gitlab.com/yourUsername/moment
cd moment cd moment
git remote add upstream https://gitlab.com/mx-moment/moment git remote add upstream https://gitlab.com/mx-moment/moment
git fetch upstream git fetch upstream
git checkout upstream/dev git checkout -b example-branch-name
git branch example-branch-name
git checkout example-branch-name
``` ```
Test and commit your changes according to the Test and commit your changes according to the
@@ -61,18 +53,18 @@ Test and commit your changes according to the
You will then be able to make a pull request by going You will then be able to make a pull request by going
to the [main repo](https://gitlab.com/mx-moment/moment). to the [main repo](https://gitlab.com/mx-moment/moment).
Once your pull request is merged, you can update `dev`, and delete your Once your pull request is merged, you can update `main`, and delete your
GitLab and local branch: GitLab and local branch:
```sh ```sh
git fetch upstream git fetch upstream
git checkout upstream/dev git checkout upstream/main
git push -d origin example-branch-name git push -d origin example-branch-name
git branch -d example-branch-name git branch -d example-branch-name
``` ```
Make sure `dev` is up-to-date before creating new branches based on it. Make sure `main` is up-to-date before creating new branches based on it.
## Commit Guidelines ## Commit Guidelines
@@ -250,7 +242,7 @@ implementation or side-effects.
or if doing it in Python requires adding a dependency while a or if doing it in Python requires adding a dependency while a
similar feature is already provided by Qt, feature that just needs to be similar feature is already provided by Qt, feature that just needs to be
exposed with some wrapper code exposed with some wrapper code
([example](https://github.com/mirukana/mirage/blob/v0.6.4/src/utils.h#L31)). ([example](https://gitlab.com/mx-moment/moment/blob/v0.6.4/src/utils.h#L31)).
- Be explicit, always use `this->` to refer to methods and class attributes - Be explicit, always use `this->` to refer to methods and class attributes
@@ -284,6 +276,6 @@ adding instructions to the [INSTALL.md](INSTALL.md) are welcome.
Some suggestions when creating packages: Some suggestions when creating packages:
- Among the dependencies from the `submodules` directory, `hsluv-c` is the - Among the dependencies from the `submodules` directory, `hsluv-c` is the
only one that is still needed for building. only one that is still needed for building.
The other folders are kept to allow building past versions of the The other folders are kept to allow building past versions of the
application, and should be ignored. application, and should be ignored.

2
docs/INSTALL.md
View File

@@ -100,7 +100,7 @@ so on the [Alpine Wiki](https://wiki.alpinelinux.org/wiki/Edge).
AUR packages for the AUR packages for the
[latest stable release](https://aur.archlinux.org/packages/moment/) and [latest stable release](https://aur.archlinux.org/packages/moment/) and
[git `dev` branch](https://aur.archlinux.org/packages/moment-git/) are [git `main` branch](https://aur.archlinux.org/packages/moment-git/) are
available. available.
Installing the release version with an AUR helper, e.g. Installing the release version with an AUR helper, e.g.