From e2169cc75ad653ae35b09dca5a7e5da77b946602 Mon Sep 17 00:00:00 2001 From: Leonard Carcaramo Date: Fri, 4 Aug 2023 13:17:32 -0400 Subject: [PATCH] Update README links and contribution guidelines. Signed-off-by: Leonard Carcaramo --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb6c3297..1b5734bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ To ensure that **code formatters _(isort and black)_**, **linters _(flake8 and p ### Adding New Functionality -If you have a new functionality that can be added to the package, open a GitHub pull request with the code. In the PR, make sure to clearly document the new functionality including why it is valuable. +If you have a new functionality that can be added to the package, open a GitHub pull request against the `dev` branch with your changes. In the PR, make sure to clearly document the new functionality including why it is valuable. ### Testing @@ -82,7 +82,7 @@ The main way to test pyRACF is to write **unit tests** in the [`tests`](tests) f ### Fixing Bugs -If you fix a bug, open a GitHub pull request with the fix. In the PR, make sure to clearly described the problem and the solution approach. +If you fix a bug, open a GitHub pull request against the `dev` branch with the fix. In the PR, make sure to clearly describe the problem and the solution approach. ### Adding or Fixing Documentation diff --git a/README.md b/README.md index 7218798e..cf856888 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,11 @@ python3 -m pip install pyracf ### Usage -* [pyRACF Documentation]() +* [pyRACF Documentation](https://ambitus.github.io/pyracf/) ## Help -* [Github Discussions]() +* [Github Discussions](https://github.com/ambitus/pyracf/discussions) ## Authors