Skip to content

Commit 27fc131

Browse files
authored
Update CONTRIBUTING.md
- updated incorrect information about Travis - included link to CI/CD tests - Merged subheadings "Formatting and Type Checking" - Updated navigation for "#### Formatting and Type Checking"
1 parent 0c457eb commit 27fc131

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
- [Draft PRs](#draft-prs)
1313
- [PRs should be a reasonable length](#prs-should-be-a-reasonable-length)
1414
- [Code style](#code-style)
15-
- [Formatting](#formatting)
16-
- [Type Checking](#type-checking)
15+
- [Formatting and Type Checking](#### Formatting and Type Checking)
1716
- [How to open a PR and contribute code to Rasa Open Source](#how-to-open-a-pr-and-contribute-code-to-rasa-open-source)
1817
- [1. Forking the Rasa Repository](#1-forking-the-rasa-repository)
1918
- [2. Cloning the Forked Repository Locally](#2-cloning-the-forked-repository-locally)
@@ -87,18 +86,17 @@ If your PR is greater than 500 lines, please consider splitting it into multiple
8786
#### Code style
8887

8988
To ensure a standardized code style we recommend using formatter black. To ensure our type annotations are correct we also suggest using the type checker pytype.
90-
Travis is a hosted continuous integration service used to build and test software projects hosted at GitHub. If your code is not formatted properly or doesn't type check, Travis will fail to build.
9189

92-
#### Formatting
90+
#### Formatting and Type Checking
9391

9492
If you want to automatically format your code on every commit, you can use pre-commit. Just install it via `pip install pre-commit` and execute `pre-commit install` in the root folder. This will add a hook to the repository, which reformats files on every commit.
9593

9694
If you want to set it up manually, install black via `pip install -r requirements-dev.txt.` To reformat files execute `make formatter`.
9795

98-
#### Type Checking
99-
10096
If you want to check types on the codebase, install pytype using `pip install -r requirements-dev.txt`. To check the types execute `make types`.
10197

98+
The CI/CD tests that we run can be found in the [continous-integration.yml](https://github.com/RasaHQ/rasa/blob/master/.github/workflows/continous-integration.yml) file.
99+
102100
---
103101

104102
## How to open a PR and contribute code to Rasa Open Source

0 commit comments

Comments
 (0)