Skip to content

Commit fa061be

Browse files
committed
Link in the new contributors guide for RTD
Tweaks to the developer guide
1 parent 341eb84 commit fa061be

2 files changed

Lines changed: 6 additions & 15 deletions

File tree

docs/devguide.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
1-
# PyEarthTools Core Developer Guide
1+
# PyEarthTools Developer Guide
22

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.
44

55
## Quick Overview
66

77
- 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.
89
- 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.
2012

2113
## Creating Your Own Fork of PyEarthTools for the First Time
2214

@@ -26,7 +18,6 @@ Unless you are an advanced Git user, we would recommend you follow this process:
2618
2. Clone **your fork**. (Do not directly clone https://github.com/ACCESS-Community-Hub/PyEarthTools).
2719
3. Immediately create a new local branch, with a command such as `git checkout -b branch_name`.
2820

29-
3021
## Workflow for Submitting Pull Requests
3122

3223
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:
6354
6. Code does not do anything unexpected or beyond the scope of the function
6455
7. Any additional dependencies are justified and do not result in bloat
6556

66-
6757
## GitHub Actions - Workflows
6858
We are using GitHub actions to automate testing and specific workflows.
6959
1. **Black** - Python code formatting. [https://pypi.org/project/black/](https://pypi.org/project/black/)

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ data
151151
config
152152
api/api
153153
roadmap
154+
contributing
154155
devguide
155156
maintainer
156157
```

0 commit comments

Comments
 (0)