Skip to content

Commit

Permalink
chore: Update GitLab links to GitHub (#372)
Browse files Browse the repository at this point in the history
* chore: Update GitLab links to GitHub

The project has moved from GitLab to GitHub so update the links.

Signed-off-by: Thanh Ha <zxiiro@gmail.com>

* Some additional fixes

Signed-off-by: Thomas Neidhart <thomas.neidhart@eclipse-foundation.org>

---------

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Signed-off-by: Thomas Neidhart <thomas.neidhart@eclipse-foundation.org>
Co-authored-by: Thomas Neidhart <thomas.neidhart@eclipse-foundation.org>
  • Loading branch information
zxiiro and Thomas Neidhart authored Jan 23, 2025
1 parent cc8074e commit 2e2b586
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@ We'd love you to contribute to Otterdog!

## Issues

Questions, feature requests and bug reports are all welcome as [discussions or issues](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/new).
Questions, feature requests and bug reports are all welcome as
[discussions](https://github.com/eclipse-csi/otterdog/discussions) or
[issues](https://github.com/eclipse-csi/otterdog/issues).

## Merge Requests
## Pull Requests

It should be extremely simple to get started and create a Merge Request.
It should be extremely simple to get started and create a Pull Request.

Unless your change is trivial (typo, docs tweak etc.), please create an issue to discuss the change before
creating a pull request.

If you're looking for something to get your teeth into, check out the
["help wanted"](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/?label_name%5B%5D=Help%20Wanted)
label on gitlab.
["help wanted"](https://github.com/eclipse-csi/otterdog/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22)
label on GitHub.

To make contributing as easy and fast as possible, you'll want to run tests and linting locally. Luckily,
Otterdog has few dependencies, doesn't require compiling and tests don't need access to databases, etc.
Expand All @@ -23,22 +25,24 @@ Because of this, setting up and running the tests should be very simple.

You'll need the following prerequisites:

- Any Python version **>= 3.10**
- Any Python version **>= 3.11**
- **git**
- **make**
- [**poetry**](https://python-poetry.org/docs/#installation)

### Installation and setup

Fork the repository on Gitlab and clone your fork locally.
Fork the repository on GitHub and clone your fork locally.

```bash
# Clone your fork and cd into the repo directory
git clone https://gitlab.eclipse.org/<your username>/otterdog.git
git clone https://github.com/<your username>/otterdog.git
cd otterdog

# Install poetry
curl -sSL https://install.python-poetry.org | python3 -
# or alternatively
pipx install poetry

# Install dependencies
make init
Expand All @@ -65,7 +69,7 @@ make test

### Commit and push your changes

Commit your changes, push your branch to Gitlab, and create a pull request.
Commit your changes, push your branch to GitHub, and create a pull request.

Please follow the pull request template and fill in as much information as possible. Link to any relevant issues and include a description of your changes.

Expand All @@ -81,7 +85,7 @@ Documentation is written in Markdown and built using [Material for MkDocs](https

### Code documentation

When contributing to Pydantic, please make sure that all code is well documented. The following should be documented using properly formatted docstrings:
When contributing to otterdog, please make sure that all code is well documented. The following should be documented using properly formatted docstrings:

- Modules
- Class definitions
Expand Down

0 comments on commit 2e2b586

Please sign in to comment.