Skip to content

Commit bf891f8

Browse files
author
Dani Bodor
committed
docs: start updating dev readme
1 parent 425e0ca commit bf891f8

1 file changed

Lines changed: 27 additions & 24 deletions

File tree

README.dev.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,27 @@ If you're looking for user documentation, go [here](README.md).
66

77
We welcome all contributions to this open-source project, as long as they follow our
88
[code of conduct](https://github.com/EIT-ALIVE/eitprocessing/blob/main/CODE_OF_CONDUCT.md).
9-
We appreciate it if you adhere to our naming and style [conventions](#conventions) below.
9+
We also ask you to adhere to our [naming and style conventions](#conventions).
10+
11+
We appreciate if you follow the steps below. Don't be discouraged if you struggle with any of these: if you feel you
12+
have made or can make a valuable contribution. We are happy to help, so please reach out! Do keep in mind that you might
13+
be asked to append additional commits or make changes to your pull request.
14+
15+
1. announce your plan to the rest of the community _before you start working_. This announcement should be done via GitHub in the form of a (new) [issue](https://github.com/EIT-ALIVE/eitprocessing/issues);
16+
2. wait until some kind of consensus is reached about your idea being a good idea;
17+
3. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
18+
4. make sure the existing [tests still work](#testing-locally) by running `pytest`;
19+
5. add your own tests (recommended);
20+
6. update or expand the documentation;
21+
7. push your feature branch (or fork) to the eitprocessing repository on GitHub;
22+
8. [create a pull request](https://help.github.com/articles/creating-a-pull-request/), following our [PR conventions]()
23+
and link it to the issue in step 1;
24+
9. ensure that all automatically generated checks pass and update make changes as required to solve any resulting issues;
25+
- it can be tricky to discover what some of the problems mean, feel free to reach out if you have difficulties finding out.
26+
10. request a review of your PR once you are happy with its state or if you require feedback.
1027

11-
Please follow these steps:
12-
13-
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
14-
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
15-
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
16-
1. make sure the existing tests still work by running `pytest` (see also [here](#testing-locally));
17-
1. add your own tests (if necessary);
18-
1. update or expand the documentation;
19-
1. update the `CHANGELOG.md` file with change;
20-
1. push your feature branch to (your fork of) the eitprocessing repository on GitHub;
21-
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
22-
23-
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
28+
Note that all contrubtions to this project will be published under our [Apache 2.0 licence]
29+
(<https://github.com/EIT-ALIVE/eitprocessing/blob/main/LICENSE>).
2430

2531
### Conventions
2632

@@ -31,21 +37,18 @@ readibility or simplicity is more important than absolute correctness.
3137
It is hard to define the precise balance we are looking for, so instead we will refer
3238
to the [Zen of python](https://peps.python.org/pep-0020/).
3339

34-
Note that all contrubtions to this project will be published under our [Apache 2.0 licence]
35-
(<https://github.com/EIT-ALIVE/eitprocessing/blob/main/LICENSE>).
40+
#### Linting and formatting
41+
42+
We use the [Ruff formatter](https://pypi.org/project/black/) to format code. If you use Visual
43+
Studio Code, the [extension by
44+
Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter) is a good
45+
place to start. This extension is currently in preview, but seems to work more reliably than older implementations.
3646

3747
#### Docstrings
3848

3949
We use the [google convention](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
4050
for writing docstrings.
4151

42-
#### Code formatting
43-
44-
We use the [Black formatter](https://pypi.org/project/black/) to format code. If you use Visual
45-
Studio Code, the [extension by
46-
Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter) is a good
47-
place to start. This extension is currently in preview, but seems to work more reliably than older implementations.
48-
4952
#### Branch naming convention
5053

5154
Please try to adhere to the following branch naming convention:
@@ -60,7 +63,7 @@ Also, it simplifies tab autocompletion when switching to your branch.
6063

6164
Please use an [angular convention type](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type),
6265
followed by a semicolon and then a description when creating a PR.
63-
E.g., `feat: added module to calculate the answer to life, the universe, and everything`.
66+
E.g., `feat: added module to calculate the answer to life, the universe, and everything`
6467

6568
### Creating a PR
6669

0 commit comments

Comments
 (0)