Skip to content

Commit 661b743

Browse files
authoredMar 16, 2025··
docs: Add Contributing file. (#124)
Suggested by Github on the Community standards tab.
1 parent 4ef8433 commit 661b743

File tree

2 files changed

+29
-30
lines changed

2 files changed

+29
-30
lines changed
 

‎CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
The goal is to have more features implemented and tested on the Actual API. If you have ideas, comments, bug fixes or
4+
requests feel free to open an issue or submit a pull request.
5+
6+
To install requirements, install both requirements files:
7+
8+
```bash
9+
# optionally setup a venv (recommended)
10+
python3 -m venv venv && source venv/bin/activate
11+
# install requirements
12+
pip install -r requirements.txt
13+
pip install -r requirements-dev.txt
14+
```
15+
16+
We use [`pre-commit`](https://pre-commit.com/) to ensure consistent formatting across different developers. To develop
17+
locally, make sure you install all development requirements, then install `pre-commit` hooks. This would make sure the
18+
formatting runs on every commit.
19+
20+
```
21+
pre-commit install
22+
```
23+
24+
To run tests, make sure you have docker installed ([how to install docker](https://docs.docker.com/engine/install/)).
25+
Run the tests on your machine:
26+
27+
```bash
28+
pytest
29+
```

‎README.md

-30
Original file line numberDiff line numberDiff line change
@@ -117,33 +117,3 @@ This means that, when using this library to operate changes on the database, you
117117
- do a sync request is made using the `actual.commit()` method. This only handles pending operations that haven't yet
118118
been committed, generates a change list with them and posts them on the sync endpoint.
119119
- do a full re-upload of the database is done.
120-
121-
# Contributing
122-
123-
The goal is to have more features implemented and tested on the Actual API. If you have ideas, comments, bug fixes or
124-
requests feel free to open an issue or submit a pull request.
125-
126-
To install requirements, install both requirements files:
127-
128-
```bash
129-
# optionally setup a venv (recommended)
130-
python3 -m venv venv && source venv/bin/activate
131-
# install requirements
132-
pip install -r requirements.txt
133-
pip install -r requirements-dev.txt
134-
```
135-
136-
We use [`pre-commit`](https://pre-commit.com/) to ensure consistent formatting across different developers. To develop
137-
locally, make sure you install all development requirements, then install `pre-commit` hooks. This would make sure the
138-
formatting runs on every commit.
139-
140-
```
141-
pre-commit install
142-
```
143-
144-
To run tests, make sure you have docker installed ([how to install docker](https://docs.docker.com/engine/install/)).
145-
Run the tests on your machine:
146-
147-
```bash
148-
pytest
149-
```

0 commit comments

Comments
 (0)
Please sign in to comment.