From f66ccdfb0b65e4e039cc2cefca9b853af20dc7f3 Mon Sep 17 00:00:00 2001 From: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com> Date: Tue, 15 Aug 2023 18:59:58 +0100 Subject: [PATCH] Update contributing guidelines Following a PR with over 10 features being added at once, the contributing guidelines have been updated to limit a PR to a single feature or multiple bug fixes. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d314341b..e98f2300 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,12 @@ For developers wanting to add features please follow these guidelines: * All code is documented using ldoc, the end result can be found [here][docs]. * Changes should be made on your own fork and merged into `dev` through a pull request. -* Pull requests are automatically linted and documentation checked. +* Each pull request should be limited to one feature or a few bug fixes. +* Pull requests are automatically checked for lint and documentation errors. * Pull requests are manually reviewed to maintain code and language quality. * New features should have the branch names: `feature/feature-name` * Bug fixes should have the branch names: `fix/bug-name` +* Commits should have meaningful messages. ## Releases