1
0
forked from clan/clan-core

Merge pull request 'Contributing.md: Fix incorrect formating.' (#1527) from Qubasa/clan-core:Qubasa-main into main

This commit is contained in:
clan-bot 2024-05-31 14:02:18 +00:00
commit 276c39aba4

View File

@ -15,74 +15,74 @@ Let's get your development environment up and running:
1. **Install Nix Package Manager**: 1. **Install Nix Package Manager**:
- You can install the Nix package manager by either [downloading the Nix installer](https://github.com/DeterminateSystems/nix-installer/releases) or running this command: - You can install the Nix package manager by either [downloading the Nix installer](https://github.com/DeterminateSystems/nix-installer/releases) or running this command:
```bash ```bash
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
``` ```
2. **Install direnv**: 2. **Install direnv**:
- To automatically setup a devshell on entering the directory - To automatically setup a devshell on entering the directory
```bash ```bash
nix profile install nixpkgs#nix-direnv-flakes nix profile install nixpkgs#nix-direnv-flakes
``` ```
3. **Add direnv to your shell**: 3. **Add direnv to your shell**:
- Direnv needs to [hook into your shell](https://direnv.net/docs/hook.html) to work. - Direnv needs to [hook into your shell](https://direnv.net/docs/hook.html) to work.
You can do this by executing following command. The example below will setup direnv for `zsh` and `bash` You can do this by executing following command. The example below will setup direnv for `zsh` and `bash`
```bash ```bash
echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc && echo 'eval "$(direnv hook bash)"' >> ~/.bashrc && eval "$SHELL" echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc && echo 'eval "$(direnv hook bash)"' >> ~/.bashrc && eval "$SHELL"
``` ```
4. **Create a Gitea Account**: 4. **Create a Gitea Account**:
- Register an account on https://git.clan.lol - Register an account on https://git.clan.lol
- Fork the [clan-core](https://git.clan.lol/clan/clan-core) repository - Fork the [clan-core](https://git.clan.lol/clan/clan-core) repository
- Clone the repository and navigate to it - Clone the repository and navigate to it
- Add a new remote called upstream: - Add a new remote called upstream:
```bash ```bash
git remote add upstream gitea@git.clan.lol:clan/clan-core.git git remote add upstream gitea@git.clan.lol:clan/clan-core.git
``` ```
5. **Register Your Gitea Account Locally**: 5. **Register Your Gitea Account Locally**:
- Execute the following command to add your Gitea account locally: - Execute the following command to add your Gitea account locally:
```bash ```bash
tea login add tea login add
``` ```
- Fill out the prompt as follows: - Fill out the prompt as follows:
- URL of Gitea instance: `https://git.clan.lol` - URL of Gitea instance: `https://git.clan.lol`
- Name of new Login [git.clan.lol]: - Name of new Login [git.clan.lol]:
- Do you have an access token? No - Do you have an access token? No
- Username: YourUsername - Username: YourUsername
- Password: YourPassword - Password: YourPassword
- Set Optional settings: No - Set Optional settings: No
6. **Allow .envrc**: 6. **Allow .envrc**:
- When you enter the directory, you'll receive an error message like this: - When you enter the directory, you'll receive an error message like this:
```bash ```bash
direnv: error .envrc is blocked. Run `direnv allow` to approve its content direnv: error .envrc is blocked. Run `direnv allow` to approve its content
``` ```
- Execute `direnv allow` to automatically execute the shell script `.envrc` when entering the directory. - Execute `direnv allow` to automatically execute the shell script `.envrc` when entering the directory.
7. **(Optional) Install Git Hooks**: 7. **(Optional) Install Git Hooks**:
- To syntax check your code you can run: - To syntax check your code you can run:
```bash ```bash
nix fmt nix fmt
``` ```
- To make this automatic install the git hooks - To make this automatic install the git hooks
```bash ```bash
./scripts/pre-commit ./scripts/pre-commit
``` ```
8. **Open a Pull Request**: 8. **Open a Pull Request**:
- To automatically open up a pull request you can use our tool called: - To automatically open up a pull request you can use our tool called:
``` ```
merge-after-ci --reviewers Mic92 Lassulus Qubasa merge-after-ci --reviewers Mic92 Lassulus Qubasa
``` ```
# Debugging # Debugging