Feat/community guidelines

.github/ISSUE_TEMPLATE/a_bug_report.yaml

@@ -0,0 +1,121 @@
+name: 🪳 Bug Report
+description: Create a report to help us reproduce and fix the bug
+
+title: '[BUG]: '
+labels:
+-   bug
+-   triage
+
+body:
+-   type: markdown
+    attributes:
+        value: >
+            **Before submitting a bug, please make sure the issue hasn't been already addressed by [searching through](https://github.com/saezlab/ontograph/issues).**
+            Please write your bug report in English to ensure it can be understood and addressed by the development team.
+
+  #----------------   Installed From --------------
+-   type: dropdown
+    id: source
+    attributes:
+        label: Source
+        description: OntoGraph has been installed from
+        options:
+        -   conda
+        -   pip
+        -   uv
+        -   poetry
+        -   other (specify in text)
+    validations:
+        required: true
+
+-   type: input
+    id: source-other
+    attributes:
+        label: other source
+        placeholder: e.g., from source
+
+  #--------------   Python version   --------------
+-   type: input
+    id: Python
+    attributes:
+        label: Python version
+        placeholder: e.g., 3.10
+    validations:
+        required: true
+
+  #--------------   OntoGraph version   --------------
+-   type: input
+    id: OntoGraph-version
+    attributes:
+        label: OntoGraph version
+        placeholder: e.g., OntoGraph v0.0.1
+    validations:
+        required: true
+
+  #--------------   OS Platform and distribution   --------------
+-   type: input
+    id: OS
+    attributes:
+        label: OS platform and distribution
+        placeholder: e.g., Linux Ubuntu 16.04
+
+  #--------------   Describe the Bug   --------------
+-   type: textarea
+    attributes:
+        label: Describe the bug
+        description: |
+            Please provide a clear and concise description of the bug.
+
+            If applicable, include a minimal example that allows us to reproduce the error by running the code.
+            It's crucial that the snippet is as short and focused as possible, so please remove any unnecessary code
+            to help us debug efficiently. We will copy and paste your code, and we expect to see the same result as you did.
+            Avoid using external data and make sure to include all relevant imports, etc. For example:
+
+            ```python
+            # All necessary imports at the beginning
+            from ontograph import ClientOntology
+
+            # A succinct reproducing example trimmed down to the essential parts:
+            go_client = ClientOntology()
+
+            go_client.load() # Note: the bug is here!
+            ```
+
+            If the code is too lengthy (though we hope it's not), feel free to place it in a public gist and share the link in the issue: https://gist.github.com.
+
+            Instead of providing the expected results, please paste or describe the actual results you observe. If you encounter an error, include the error message along with the full traceback. It's helpful to wrap error messages in ```` ```triple quotes blocks``` ````.
+        placeholder: |
+            A clear and concise description of what the bug is.
+
+            ```python
+            # Sample code to reproduce the problem
+            ```
+
+            ```
+            The error message you got, with the full traceback.
+            ```
+    validations:
+        required: true
+
+  #--------------   Relevant LOG Output   --------------
+-   type: textarea
+    id: logs
+    attributes:
+        label: Relevant LOG output
+        description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        render: shell
+
+  #--------------   Code of Conduct   --------------
+-   type: checkboxes
+    id: terms
+    attributes:
+        label: Code of Conduct
+        description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/saezlab/ontograph/blob/main/CODE_OF_CONDUCT.md).
+        options:
+        -   label: I agree to follow this project's Code of Conduct
+            required: true
+
+-   type: markdown
+    attributes:
+        value: >
+            Thank you for your contribution! 🎉 – Saezlab Organization - OmniPath team

.github/ISSUE_TEMPLATE/b_feature_request.yaml

@@ -0,0 +1,69 @@
+name: ✨ Feature Request
+description: Submit a proposal/request for a new OntoGraph feature
+
+title: '[FEAT]: '
+labels:
+-   feature
+projects: [ontograph/1]
+
+body:
+-   type: markdown
+    attributes:
+        value: >
+            **Note:** Please write your bug report in English to ensure it can be understood and addressed by the development team.
+
+  #--------------   Feature type    --------------
+-   type: dropdown
+    id: feature-type
+    attributes:
+        label: Feature Type
+        description: Please select what type of feature request you would like to propose.
+        options:
+        -   Add new functionality to OntoGraph
+        -   Change existing functionality in OntoGraph
+        -   Remove existing functionality in OntoGraph
+        multiple: false
+    validations:
+        required: true
+
+  #--------------   Feature description and motivation    --------------
+-   type: textarea
+    attributes:
+        label: 🚀 The feature and motivation
+        description: >
+            Provide a clear and concise summary of the proposed feature, including the motivation behind it.
+            If your request addresses a specific problem, describe it (e.g., "I'm working on X and need Y to be achievable").
+            If this is connected to an existing GitHub issue, please include a link.
+        placeholder: |
+            **Feature description**
+              As a user, I would like the ability to import a csv file from SwissLipids and create an ontology with this data.
+
+            **Motivation**
+              Enabling users to import CSV files from SwissLipids and automatically generate an ontology streamlines the integration
+              of curated lipid data into the platform. This functionality reduces manual preprocessing, ensures data consistency, 
+              and accelerates research workflows, while supporting reproducibility and adherence to community standards.
+
+    validations:
+        required: true
+
+  #--------------   Additional context    --------------
+-   type: textarea
+    attributes:
+        label: Additional context
+        description: >
+            Add any other context or screenshots about the feature request.
+
+  #--------------   Code of Conduct   --------------
+-   type: checkboxes
+    id: terms
+    attributes:
+        label: Code of Conduct
+        description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/saezlab/ontograph/blob/main/CODE_OF_CONDUCT.md).
+        options:
+        -   label: I agree to follow this project's Code of Conduct
+            required: true
+
+-   type: markdown
+    attributes:
+        value: >
+            Thank you for your contribution! 🎉 – Saezlab Organization - OmniPath team

.github/ISSUE_TEMPLATE/c_documentation.yaml

@@ -0,0 +1,57 @@
+name: 📔 Documentation Improvement
+description: Report wrong or missing documentation
+
+title: '[DOC]: '
+labels:
+-   docs
+-   triage
+projects: [ontograph/1]
+
+body:
+#----------------   Location of the documentation --------------
+-   type: textarea
+    id: location
+    attributes:
+        label: Location of the documentation
+        description: >
+            Please provide the location of the documentation, e.g. "catalog.load_catalog()" or the
+            URL of the documentation, e.g.
+            "https://saezlab.github.io/ontograph/reference/source/ontograph/client-catalog/"
+        placeholder: https://saezlab.github.io/ontograph/reference/source/ontograph/client-catalog/
+    validations:
+        required: true
+
+#----------------   Problem Description --------------
+-   type: textarea
+    id: problem
+    attributes:
+        label: Documentation problem
+        description: >
+            Please provide a description of what documentation you believe needs to be fixed/improved
+    validations:
+        required: true
+
+#----------------   Suggested Fix  --------------
+-   type: textarea
+    id: suggested-fix
+    attributes:
+        label: Suggested fix for documentation
+        description: >
+            Please explain the suggested fix and **why** it's better than the existing documentation
+    validations:
+        required: true
+
+#--------------   Code of Conduct   --------------
+-   type: checkboxes
+    id: terms
+    attributes:
+        label: Code of Conduct
+        description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/saezlab/ontograph/blob/main/CODE_OF_CONDUCT.md).
+        options:
+        -   label: I agree to follow this project's Code of Conduct
+            required: true
+
+-   type: markdown
+    attributes:
+        value: >
+            Thank you for your contribution! 🎉 – Saezlab Organization - OmniPath team

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,79 @@
+# Pull Request
+
+> When to use: Use this default template for most changes (features, small fixes, refactors, docs). If your change is a bug fix, performance optimization, maintenance/chore, or a breaking change, consider using one of the specialized templates under `.github/PULL_REQUEST_TEMPLATE/`.
+
+Thank you for contributing to OntoGraph! Please fill out the sections below to help us review efficiently.
+
+## Summary
+
+- Link to issue(s): Closes #<issue-number> (or) Related to #<issue-number>
+- Brief description of the change:
+
+## Type of change
+
+Select one or more:
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] Feature (non-breaking change that adds functionality)
+- [ ] Documentation update
+- [ ] Refactor/maintenance (no functional change)
+- [ ] Performance improvement
+- [ ] CI/CD or tooling
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Changes
+
+- High-level list of changes (modules, major functions/classes touched)
+- Any data files or schema changes
+- Any API changes (inputs/outputs, public interfaces)
+
+## Screenshots or demos (optional)
+
+If relevant, include images, terminal outputs, or notebook snippets.
+
+## Checklist
+
+- Code quality & style
+  - [ ] Follows project style and conventions
+  - [ ] Pre-commit hooks run locally
+
+    ```bash
+    pre-commit run -a
+    ```
+- Tests
+  - [ ] Unit tests added/updated
+  - [ ] All tests pass locally (`pytest`) 
+  - [ ] Includes edge cases (empty/null, invalid input, large inputs)
+- Documentation
+  - [ ] User docs updated (MkDocs in `docs/` as needed)
+  - [ ] README updated if behavior or usage changed
+  - [ ] Docstrings and comments added where helpful
+- Reliability
+  - [ ] No secrets or credentials in code or history
+  - [ ] Backwards compatibility considered; migration notes added if breaking
+  - [ ] Performance implications considered (time/memory), benchmarks if relevant
+- Project hygiene
+  - [ ] Linked issues referenced with `Closes #...` or `Related to #...`
+  - [ ] Changelog entry prepared (see `CHANGELOG.md`)
+  - [ ] Labels applied (bug, enhancement, docs, etc.)
+- Community standards
+  - [ ] I have read and agree to the [Code of Conduct](../CODE_OF_CONDUCT.md)
+
+## Test plan
+
+Describe how you tested the changes. Include commands, datasets, and expected outcomes. If applicable, reference tests in `tests/`:
+
+```bash
+# Example (adjust as needed)
+pytest -q
+```
+
+## Breaking changes (if any)
+
+- Describe what breaks and how users should migrate.
+- Provide a migration example or script if possible.
+
+## Additional context
+
+- Risks, trade-offs, or follow-up tasks
+- Dependencies or environment changes
+- Related PRs

.github/PULL_REQUEST_TEMPLATE/breaking_change.md

@@ -0,0 +1,39 @@
+# Breaking Change Pull Request
+
+> When to use: Changes that break backwards compatibility; requires a migration guide and communication plan.
+
+## Summary
+- Closes #<issue-number>
+- Scope and rationale for breaking change
+
+## Deprecation & Migration
+- Deprecation path and timeline
+- Migration guide and examples
+- Scripts or tools to assist migration
+
+## API / Data impacts
+- Public API changes
+- Data/schema changes
+
+## Versioning & Communication
+- Version bump strategy
+- Communication plan (release notes, docs)
+
+## Tests
+- [ ] Updated tests for new behavior
+- [ ] Migration tests where possible
+- [ ] All tests pass locally (`pytest -q`)
+
+## Documentation
+- [ ] Docs updated (MkDocs) and README
+- [ ] Clear migration instructions visible to users
+
+## Checklist
+- [ ] Backwards compatibility noted as broken (explicit)
+- [ ] Changelog entry prepared (see `CHANGELOG.md`)
+- [ ] Risk assessment and rollback plan
+- [ ] Labels set (breaking-change)
+- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md)
+
+## Additional notes
+- Known limitations and follow-ups