Skip to content

Commit

Permalink
Add information about CKAN extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
ItaloBorrelli committed Oct 15, 2024
1 parent 7611896 commit f017d60
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ This document will guide you through the process of making contributions. Please

## Getting Started

1. **Fork the repository**: Before you can contribute, you need to have your own fork of the project.
2. **Clone your fork**: Get a copy of your fork locally so that you can start making changes.
3. **Set up your development environment**: Follow the setup instructions in the README to set up your local environment.
1. **Clone the repository**: Clone the repository so you can start developing locally.
2. **Set up your development environment**: Follow the setup instructions in the README to set up your local environment.

## Contribution Workflow

Expand All @@ -16,15 +15,29 @@ Before starting work, check the issue tracker for existing issues or discussions

### Determine if the issue is related to CKAN or a CKAN extension

There are many extensions that are a part of this project. If the changes should be made on an extension:
There are many extensions that are a part of this project. See the "CKAN Extensions" section to understand the scope covered by extensions to determine where to contribute. If the changes should be made on an extension:

1. **Create or find a related issue in the extension repo**: If none exists within the extension repo and create a branch on it.
2. **Follow the "Making Changes" instructions to make changes in that repo**
3. **Continue within the cioos-siooc/ckan repo to update submodules**

#### CKAN extensions
#### CKAN Extensions

TODO Layout extensions
This repository specifically handles the easy installation of a CIOOS-SIOOC CKAN instance through docker with the requisite extensions being installed. Any contributions to that end can be done within this repository. Often, changes will need to be made to extensions, most of which we manage as forks of the original extension. To figure out what extension to contribute to, see the brief description here. If more information is needed, see the README.md at the given link, and the CIOOS-SIOOC Changes section if one exists.

|Submodule|cioos/siooc Repository?|Description|Repository|
|---------|-----------------|-----------|:--------:|
|ckanext-cioos_theme||Themes CKAN for CIOOS-SIOOC to customize displayed metadata fields and support searching by EOV.|[link](https://github.com/cioos-siooc/ckanext-cioos_theme.git)|
|ckanext-harvest||Enables harvesting from a variety of sources. Our fork enables deletion of remote datasets that no longer exist, and the ability to filter datasets to include or exclude.|[link](https://github.com/cioos-siooc/ckanext-harvest.git)|
|ckanext-spatial||Allows the import of geospatial metadata into CKAN. Our fork handles the ability to parse of ISO 19115 xml metadata, and implements some CIOOS-SIOOC specific requirements, such as EOVs & ECVs, geospatial information.|[link](https://github.com/cioos-siooc/ckanext-spatial.git)|
|ckanext-scheming||Defines the schema for the datasets. Much of this is handled through the `cioos-siooc-schema` repository, but this repository includes some customization of the original `ckanext-scheming` extension, such as placeholders and specific validation as determined by CIOOS-SIOOC|[link](https://github.com/cioos-siooc/ckanext-scheming.git)|
|cioos-siooc-schema||A custom extension to contribute custom CIOOS-SIOOC metadata for the `ckanext-scheming` repository, such as EOVs and specific schemas for groups, organizations and licenses.|[link](https://github.com/cioos-siooc/cioos-siooc-schema.git)|
|ckanext-fluent||Enables CKAN to be multilingual.|[link](https://github.com/cioos-siooc/ckanext-fluent.git)|
|ckanext-cioos_harvest||A custom extension to translate ISO 19115-3 (xml implmentation) into the ISO 19115-1 format.|[link](https://github.com/cioos-siooc/ckanext-cioos_harvest.git)|
|ckanext-geoview||An extension providing the Geospatial viewer for CKAN.|[link](https://github.com/ckan/ckanext-geoview.git)|
|ckanext-dcat||Enables CKAN metadata to be translated to serialized RDF.|[link](https://github.com/ckan/ckanext-dcat.git)|

#### Update Submodules

### Making Changes

Expand All @@ -41,7 +54,7 @@ TODO Layout extensions
### Pull Requests

1. **Push your changes to your fork**.
2. **Open a pull request**: Target the main repository’s relevant branch. Fill in the pull request template, including what your code does and any other relevant details.
2. **Open a pull request**: Target the repository’s `cioos_dev` branch. Fill in the pull request template, including what your code does and any other relevant details.
3. **Review process**: Maintain an active dialogue if there are any comments or suggestions from the maintainers.

## Coding Standards
Expand All @@ -50,11 +63,6 @@ TODO Layout extensions
- **Documentation**: Ensure that every function is properly documented, following the documentation standards used in the project.
- **Testing**: Aim for thorough test coverage. Include unit tests for all new features and bug fixes.

## Community and Conduct

- **Engage with the community**: Join our community channels (e.g., Slack, forums) if you have not already.
- **Follow our Code of Conduct**: We are committed to providing a welcoming and inspiring community for all.

## Need help?

If you need help with anything, feel free to ask questions on the community communication channels or directly in GitHub issues.
Expand Down

0 comments on commit f017d60

Please sign in to comment.