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
Copy file name to clipboardExpand all lines: docs/devguide.md
+5-15Lines changed: 5 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,14 @@
1
-
# PyEarthTools Core Developer Guide
1
+
# PyEarthTools Developer Guide
2
2
3
-
This is a summary only, and should be expanded to provide more detail. This is intended to provide succinct guidance to the team of people directly involved in coding the PyEarthTools framework. Other guides will be produced for other contributor demographics (such as those involved in producing documentation, tutorials, or other kinds of contribution).
3
+
This is a summary only, and should be expanded to provide more detail. This is intended to provide succinct guidance to those who want to contribute code to PyEarthTools.
4
4
5
5
## Quick Overview
6
6
7
7
- Please fork the repository and do your development on your fork. Create pull requests from your fork.
8
+
- Use feature branches on your fork, and use a unique branch for every pull request.
8
9
- Unit test coverage on new pull requests should meet or extend existing levels of test coverage.
9
-
10
-
11
-
## Coding Guidelines
12
-
13
-
- Use 'black' and 'isort' with a line length of 120 characters
14
-
15
-
## Nice-to-haves
16
-
17
-
- Type hints would be nice, but the development so far hasn't required them. Do your best.
18
-
- Pylint checking is a good idea, please turn it on and do your best.
19
-
10
+
- We use 'black' and 'ruff check' and supply configuration files for each.
11
+
- Type hints are not required.
20
12
21
13
## Creating Your Own Fork of PyEarthTools for the First Time
22
14
@@ -26,7 +18,6 @@ Unless you are an advanced Git user, we would recommend you follow this process:
26
18
2. Clone **your fork**. (Do not directly clone https://github.com/ACCESS-Community-Hub/PyEarthTools).
27
19
3. Immediately create a new local branch, with a command such as `git checkout -b branch_name`.
28
20
29
-
30
21
## Workflow for Submitting Pull Requests
31
22
32
23
Prior to developing a pull request, it may be a good idea to create a GitHub issue to capture what the pull request is trying to achieve, any pertinent details, and (if applicable) how it aligns to the roadmap. Otherwise, please explain this in the pull request.
@@ -63,7 +54,6 @@ A code review is responsible for checking the following:
63
54
6. Code does not do anything unexpected or beyond the scope of the function
64
55
7. Any additional dependencies are justified and do not result in bloat
65
56
66
-
67
57
## GitHub Actions - Workflows
68
58
We are using GitHub actions to automate testing and specific workflows.
0 commit comments