mirror of
https://github.com/p2p-ld/nwb-linkml.git
synced 2024-09-19 15:34:28 +00:00
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
|
# Contributing to nwb-schema-language
|
||
|
|
|
||
|
|
:+1: First of all: Thank you for taking the time to contribute!
|
||
|
|
|
||
|
|
The following is a set of guidelines for contributing to
|
||
|
|
nwb-schema-language. These guidelines are not strict rules.
|
||
|
|
Use your best judgment, and feel free to propose changes to this document
|
||
|
|
in a pull request.
|
||
|
|
|
||
|
|
## Table Of Contents
|
||
|
|
|
||
|
|
* [Code of Conduct](#code-of-conduct)
|
||
|
|
* [Guidelines for Contributions and Requests](#contributions)
|
||
|
|
* [Reporting problems with the data model](#reporting-bugs)
|
||
|
|
* [Requesting new terms](#requesting-terms)
|
||
|
|
* [Adding new terms yourself](#adding-terms)
|
||
|
|
* [Best Practices](#best-practices)
|
||
|
|
* [How to write a great issue](#great-issues)
|
||
|
|
* [How to create a great pull/merge request](#great-pulls)
|
||
|
|
|
||
|
|
<a id="code-of-conduct"></a>
|
||
|
|
|
||
|
|
## Code of Conduct
|
||
|
|
|
||
|
|
The nwb-schema-language team strives to create a
|
||
|
|
welcoming environment for editors, users and other contributors.
|
||
|
|
Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||
|
|
|
||
|
|
<a id="contributions"></a>
|
||
|
|
|
||
|
|
## Guidelines for Contributions and Requests
|
||
|
|
|
||
|
|
<a id="reporting-bugs"></a>
|
||
|
|
|
||
|
|
### Reporting problems with the data model
|
||
|
|
|
||
|
|
Please use our [Issue Tracker][issues] to report problems with the ontology.
|
||
|
|
|
||
|
|
<a id="requesting-terms"></a>
|
||
|
|
|
||
|
|
### Requesting new terms
|
||
|
|
|
||
|
|
Please use our [Issue Tracker][issues] to request a new term for the ontology.
|
||
|
|
|
||
|
|
<a id="adding-terms"></a>
|
||
|
|
|
||
|
|
### Adding new terms yourself
|
||
|
|
|
||
|
|
Please submit a [Pull Request][pulls] to submit a new term for consideration.
|
||
|
|
|
||
|
|
<a id="best-practices"></a>
|
||
|
|
|
||
|
|
## Best Practices
|
||
|
|
|
||
|
|
<a id="great-issues"></a>
|
||
|
|
|
||
|
|
### How to write a great issue
|
||
|
|
|
||
|
|
Please review GitHub's overview article,
|
||
|
|
["Tracking Your Work with Issues"][about-issues].
|
||
|
|
|
||
|
|
<a id="great-pulls"></a>
|
||
|
|
|
||
|
|
### How to create a great pull/merge request
|
||
|
|
|
||
|
|
Please review GitHub's article, ["About Pull Requests"][about-pulls],
|
||
|
|
and make your changes on a [new branch][about-branches].
|
||
|
|
|
||
|
|
[about-branches]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches
|
||
|
|
[about-issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
|
||
|
|
[about-pulls]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
|
||
|
|
[issues]: https://github.com/p2p_ld/nwb-schema-language/issues/
|
||
|
|
[pulls]: https://github.com/p2p_ld/nwb-schema-language/pulls/
|