doc: apply license and add contribution guide

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to rdfpipe-rs
+
+**Thank you very much for considering contributing to this project!**
+
+We welcome any form of contribution:
+
+  * New issues (feature requests, bug reports, questions, ideas, ...)
+  * Pull requests (documentation improvements, code improvements, new features, ...)
+
+**Note**: Before you take the time to open a pull request, please open an issue first. This will
+give us the chance to discuss any potential changes first.
+
+## Opening a pull request (PR)
+
+Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from main.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Create the pull request!
+
+**Note:** PRs can only be merged if the [`build`](https://github.com/SDSC-ORD/rdfpipe-rs/blob/main/.github/workflows/rust.yml) GitHub action passes.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its GPL-3.0 License.
+
+## Important links
+
+  * [Open issues](https://github.com/SDSC-ORD/rdfpipe-rs/issues)
+  * [Open pull requests](https://github.com/SDSC-ORD/rdfpipe-rs/pulls)
+  * [Development section in the README](https://github.com/SDSC-ORD/rdfpipe-rs#development)
+  * [LICENSE](https://github.com/SDSC-ORD/rdfpipe-rs/blob/main/LICENSE)

README.md

@@ -50,3 +50,27 @@ Options:
   -h, --help                           Print help
 ```
 
+## Development
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) to learn about the different ways you can contribute to rdfpipe-rs.
+
+```sh
+# Install for development
+git clone https://github.com/SDSC-ORD/rdfpipe-rs
+cd rdfpipe-rs
+
+# Run unit and integration tests
+cargo test
+
+# Build documentation
+cargo doc
+
+# Build debug binary
+cargo build
+
+# Build optimized binary
+cargo build --release
+
+# Install
+cargo install --path .
+```

src/cli.rs

@@ -1,3 +1,20 @@
+// rdfpipe-rs
+// Copyright (C) 2023 - Swiss Data Science Center (SDSC)
+// A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+// Eidgenössische Technische Hochschule Zürich (ETHZ).
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //! Command line interface for the RDF conversion tool.
 use clap;
 use clap::{Parser, ValueEnum};

src/converter.rs

@@ -1,3 +1,20 @@
+// rdfpipe-rs
+// Copyright (C) 2023 - Swiss Data Science Center (SDSC)
+// A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+// Eidgenössische Technische Hochschule Zürich (ETHZ).
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //! # Conversion logic
 //!
 //! This module contains the `RdfIO` trait which is used to parse and serialize RDF graphs.

src/formats.rs

@@ -1,3 +1,20 @@
+// rdfpipe-rs
+// Copyright (C) 2023 - Swiss Data Science Center (SDSC)
+// A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+// Eidgenössische Technische Hochschule Zürich (ETHZ).
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //! # Implementation of concrete RDF formats
 //!
 //! This module implements `RdfIO` trait for each RDF serialization format.

src/io.rs

@@ -1,3 +1,20 @@
+// rdfpipe-rs
+// Copyright (C) 2023 - Swiss Data Science Center (SDSC)
+// A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+// Eidgenössische Technische Hochschule Zürich (ETHZ).
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //! # Input and Output helpers
 //!
 //! This module contains the `Input` and `Output` helper structs.

src/main.rs

@@ -1,3 +1,20 @@
+// rdfpipe-rs
+// Copyright (C) 2023 - Swiss Data Science Center (SDSC)
+// A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+// Eidgenössische Technische Hochschule Zürich (ETHZ).
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //! # rdfpipe-rs
 //!
 //! A command-line tool for converting between RDF serialization formats.