From 6d610336ffd54bde486c76a5e0c3278983a1dde6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20M=C3=A9nager?= Date: Thu, 4 Jul 2024 12:18:58 +0200 Subject: [PATCH] Update CONTRIBUTING.md update project name and bug info --- CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64362b1..62c0d0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,20 @@ -# EDAM validation contribution guidelines +# Caseologue contribution guidelines ### Pull requests -The recommended way for contributors to submit code to EDAM validation is to fork the repository on GitHub and then submit a pull request (PR) after committing the changes. The maintainers will then review the request before it is merged into the main branch. +The recommended way for contributors to submit code to **caseologue** is to fork the repository on GitHub and then submit a pull request (PR) after committing the changes. The maintainers will then review the request before it is merged into the main branch. Please make one PR per issue, solving multiple issues in the same PR make it harder to assess independently each solution and delay the moment changes can be merge. No bulk reformatting, only reformat code that is already changed by the code you wrote when solving the issue you are addressing. -The contributed code will be [**licensed under EDAM validation's license**](https://github.com/edamontology/edam-validation/blob/main/LICENSE). +The contributed code will be [**licensed under caseologue's license**](https://github.com/edamontology/caseologue/blob/main/LICENSE). If you did not write the code yourself, please ensure that the license is compatible, or obtain a permission from the original author to relicense the contributed code. Please include license information in the contributed files. ### Bug reports and feature requests -If you have encountered a problem with the EDAM validation tool or would like to discuss a new feature or idea, please submit it to the [issue tracker](https://github.com/edamontology/edam-validation/issues) on GitHub. +If you have encountered a problem with the EDAM validation tool or would like to discuss a new feature or idea, please submit it to the [issue tracker](https://github.com/edamontology/caseologue/issues) on GitHub. -For bug reports, please provide the steps that led you to this bug, a screenshot of the glitch when relevant, the custom -JSON ontology file used when relevant, and in general all the information which would help us reproduce the bug. +For bug reports, please provide the steps that led you to this bug, including the version of the code your are using, the EDAM file that generates the problem, and in general all the information which would help us reproduce the bug.