You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[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
7
7
8
8
Your contributions are appreciated and will be taken seriously.
9
9
@@ -15,63 +15,44 @@ Report problems or suggest improvements by [creating an issue](https://github.co
15
15
16
16
### 2. Fork the project
17
17
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.
19
19
20
20
### 3. Make changes
21
21
22
22
Clone your fork locally and make the necessary changes:
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/).
31
32
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.
35
34
36
35
> **Resource requirements**:
37
36
> -`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).
38
37
> -`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).
39
38
>
40
39
> On systems with limited RAM, use `make molecule-converge` for a quick functional test, then `make molecule-destroy` to clean up.
41
40
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)
46
45
47
-
To test a specific distribution, set `distro`, `tag`, and `namespace`:
46
+
To test a specific distribution, set `IMAGE_NAMESPACE`and `IMAGE_DISTRO`:
48
47
49
48
```bash
50
-
IMAGE_NAMESPACE=geerlingguy IMAGE_DISTRO=debian12 make molecule-converge
49
+
IMAGE_NAMESPACE=geerlingguy IMAGE_DISTRO=debian13 make molecule-converge
51
50
```
52
51
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
-
69
52
### 5. Submit a pull request
70
53
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.
72
55
73
56
### 6. Wait
74
57
75
58
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