Skip to content

Commit c839c81

Browse files
committed
Remove Gitpod config and update CONTRIBUTING
1 parent 74da6b7 commit c839c81

3 files changed

Lines changed: 14 additions & 122 deletions

File tree

.config/gitpod/Dockerfile

Lines changed: 0 additions & 83 deletions
This file was deleted.

.gitpod.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 14 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Contributing Guide
22

3-
Help improve this project by:
3+
You can help improve this project by:
44

5-
- [Creating an issue](https://help.github.com/articles/creating-an-issue/) (Check for [known issues](https://github.com/search?q=user%3Avitabaks+is%3Aissue+state%3Aopen) first)
6-
- [Submitting a pull request](https://docs.github.com/fr/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to fix a problem or add a feature
5+
- [Creating an issue](https://docs.github.com/issues/tracking-your-work-with-issues/creating-an-issue) after checking [open issues](https://github.com/autobase-tech/autobase/issues)
6+
- [Submitting a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to fix a problem or add a feature
77

88
Your contributions are appreciated and will be taken seriously.
99

@@ -15,63 +15,44 @@ Report problems or suggest improvements by [creating an issue](https://github.co
1515

1616
### 2. Fork the project
1717

18-
[Fork the repository](https://github.com/autobase-tech/autobase) to your GitHub account.
18+
[Fork the repository](https://github.com/autobase-tech/autobase) into your GitHub account.
1919

2020
### 3. Make changes
2121

2222
Clone your fork locally and make the necessary changes:
2323

2424
```bash
2525
git clone git@github.com:YOURNAMESPACE/autobase.git
26+
cd autobase
2627
```
2728

2829
### 4. Test your changes
2930

30-
#### 4.1 Desktop
31+
Install [make](https://www.gnu.org/software/make/), [Python](https://www.python.org/), [venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/), and [Docker](https://docs.docker.com/engine/install/).
3132

32-
Install [make](https://www.gnu.org/software/make/), [Python3.12](https://www.python.org/), [venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/), and [docker](https://docs.docker.com/engine/install/ubuntu/).
33-
34-
Run `make` for Makefile help.
33+
Run `make` to see the available commands.
3534

3635
> **Resource requirements**:
3736
> - `make molecule-converge` — creates 3 containers and deploys a PostgreSQL cluster. **Minimum: 4 GB RAM, 2 CPU cores, 10 GB disk** (8 GB RAM recommended).
3837
> - `make tests` — runs all test scenarios and is significantly more resource-intensive. **Minimum: 8 GB RAM, 4 CPU cores, 20 GB disk** (16 GB RAM recommended).
3938
>
4039
> On systems with limited RAM, use `make molecule-converge` for a quick functional test, then `make molecule-destroy` to clean up.
4140
42-
1. Initialize virtualenv and install dependencies with: `make bootstrap-dev`
43-
2. Run Prettier formatting: `make prettier`
44-
3. Lint your code with `make lint`
45-
4. Test your changes with: `make molecule-converge` (lightweight) or `make tests` (all scenarios)
41+
1. Create a virtual environment and install dependencies: `make bootstrap-dev`
42+
2. Format your changes: `make prettier`
43+
3. Lint your changes: `make lint`
44+
4. Run the tests: `make molecule-converge` (lightweight) or `make tests` (all scenarios)
4645

47-
To test a specific distribution, set `distro`, `tag`, and `namespace`:
46+
To test a specific distribution, set `IMAGE_NAMESPACE` and `IMAGE_DISTRO`:
4847

4948
```bash
50-
IMAGE_NAMESPACE=geerlingguy IMAGE_DISTRO=debian12 make molecule-converge
49+
IMAGE_NAMESPACE=geerlingguy IMAGE_DISTRO=debian13 make molecule-converge
5150
```
5251

53-
#### 4.2 Gitpod
54-
55-
Use Gitpod for a cloud-based development environment:
56-
57-
1. Sign up for Gitpod: https://gitpod.io
58-
2. Fork the `autobase` repository
59-
3. Open your fork in Gitpod: `https://gitpod.io/#https://github.com/username/autobase`
60-
4. Create a new branch: `git checkout -b my-feature-branch`
61-
5. Make your changes and commit: `git add .` and `git commit -m "Description of changes"`
62-
6. Run Prettier formatting: `make prettier`
63-
7. Test with linters: `make lint`
64-
8. Test with Molecule: `make molecule-converge` (lightweight) or `make tests` (all scenarios)
65-
9. Push your changes: `git push origin my-feature-branch`
66-
67-
Keep your Gitpod workspace synced with the main repository.
68-
6952
### 5. Submit a pull request
7053

71-
[Create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) and [refer to the issue number](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) using #123, where 123 is the issue number.
54+
[Create a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) and [refer to the issue number](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls) using #123, where 123 is the issue number.
7255

7356
### 6. Wait
7457

7558
Your pull request will be reviewed, and you’ll receive feedback. Thanks for contributing!
76-
77-
Consider sponsoring the maintainer via [GitHub](https://github.com/sponsors/vitabaks) or [Patreon](https://patreon.com/vitabaks).

0 commit comments

Comments
 (0)