diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b8b2de3..1e383292 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,14 +6,17 @@ When contributing to this repository, please first discuss the changes you wish ### Reporting bugs or making feature requests -You can use the [Issues](https://github.com/linkml/linkml-runtime/issues) tab to create bug and feature requests. Providing enough details to the developers to verify and troubleshoot your issue is paramount: +To report a bug or suggest a new feature, please go to the [linkml/linkml issue tracker](https://github.com/linkml/linkml/issues), as we are +consolidating issues there. + +Please supply enough details to the developers to enable them to verify and troubleshoot your issue: * Provide a clear and descriptive title as well as a concise summary of the issue to identify the problem. * Describe the exact steps which reproduce the problem in as many details as possible. * Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior. * Explain which behavior you expected to see instead and why. * Provide screenshots of the expected or actual behaviour where applicable. -* Tag the issue with appropriate label names. For ex., if your issue is about a bug that needs to be fixed in the repo, tag the issue with the `bug` label from the list of [labels](https://github.com/linkml/linkml-runtime/labels). If an appropriate label name doesn't exist, create one, with a name that clearly encapsulates the topic of the issue. +* Tag the issue with appropriate label names. For example, if your issue is about a bug that needs to be fixed in the repo, tag the issue with the `bug` label from the list of [labels](https://github.com/linkml/linkml-runtime/labels). If an appropriate label doesn't exist, create one, with a name that clearly encapsulates the topic of the issue. ### The development lifecycle @@ -24,6 +27,8 @@ You can use the [Issues](https://github.com/linkml/linkml-runtime/issues) tab to Note: All the development must be done on a branch on your fork. +ALSO NOTE: github.com lets you create a pull request from the main branch, automating the steps above. + > A code review (which happens with both the contributor and the reviewer present) is required for contributing. ## Development environment setup