Skip to content

Commit 4d61289

Browse files
authored
Merge pull request #131 from Sage-Bionetworks-Workflows/phil-update-readme
Make CONTRIBUTING.md more prominent in README.md
2 parents 4505e0e + 895a29e commit 4d61289

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## Development
44

5+
The following section is divided into three parts:
6+
7+
1. **Environment** – Development information related to the infrastructure or environment in which DAGs run.
8+
2. **Structure** – Development information related to DAG logic/code.
9+
3. **Testing** – Testing DAGs
10+
511
### Environment
612

713
The development environment breaks down into two categories: Infrastructure and Code. This is because the repo contains both:

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This repository contains Airflow recipes (DAGs) for data processing and engineer
1111

1212
## Airflow Development
1313

14+
For instructions on how to set up the development environment and interface with Airflow, see below. For a detailed guide on how to add or update DAGs and make changes to the Airflow infrastructure or environment, see [CONTRIBUTING.md](./CONTRIBUTING.md).
15+
1416
### Setting up the Dev Environment
1517

1618
A complete Airflow deployment is made up of multiple services running in parallel, so the steps involved in setting up a dev environment are more complex than you may be used to. There are two steps involved in setting up Airflow for development:

0 commit comments

Comments
 (0)