Merge pull request #1 from macielti/cleaning-repository

Initial Version "0.1.0"
macielti · Sep 5, 2021 · ecf1d05 · ecf1d05
2 parents f4ec283 + bca0d99
commit ecf1d05
Show file tree

Hide file tree

Showing 14 changed files with 852 additions and 19 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,29 @@
+<!--- Provide a general summary of your changes in the Title above -->
+## Description
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
diff --git a/.github/workflows/github_actions.yml b/.github/workflows/github_actions.yml
@@ -0,0 +1,15 @@
+name: Clojure CI - Unit and Integration Tests
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    name: Running Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: lein deps
+      - name: Run tests
+        run: lein test
diff --git a/README.md b/README.md
@@ -1,22 +1,28 @@
+![Clojure CI - Unit and Integration Tests](https://github.com/macielti/common-clj/actions/workflows/github_actions.yml/badge.svg)
+
 # common-clj
 
-A Clojure library designed to ... well, that part is up to you.
+Just common Clojure code that I use across projects
 
 ## Usage
 
-FIXME
+To install, add the following dependency to your project or build file:
+
+`[net.clojars.macielti/common-clj "0.1.0"]`
 
 ## License
 
-Copyright © 2021 FIXME
+Copyright © 2021 Bruno do Nascimento Maciel
 
-This program and the accompanying materials are made available under the
-terms of the Eclipse Public License 2.0 which is available at
+This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which
+is available at
 http://www.eclipse.org/legal/epl-2.0.
 
-This Source Code may also be made available under the following Secondary
-Licenses when the conditions for such availability set forth in the Eclipse
-Public License, v. 2.0 are satisfied: GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or (at your
-option) any later version, with the GNU Classpath Exception which is available
-at https://www.gnu.org/software/classpath/license.html.
+This Source Code may also be made available under the following Secondary Licenses when the conditions for such
+availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU
+Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.
+
+## Bibliography
+- [Versionamento Semântico 2.0.0](https://semver.org/lang/pt-BR/)
+- [Library Development and Distribution](http://clojure-doc.org/articles/ecosystem/libraries_authoring.htmls)
diff --git a/doc/intro.md b/doc/intro.md
@@ -1,3 +1,3 @@
 # Introduction to common-clj
 
-TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)
+Just common Clojure code that I use across projects.
diff --git a/docs/common-clj.schema.core.html b/docs/common-clj.schema.core.html
@@ -0,0 +1,4 @@
+<!DOCTYPE html PUBLIC ""
+    "">
+<html><head><meta charset="UTF-8" /><title>common-clj.schema.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Common-clj</span> <span class="project-version">0.1.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to common-clj</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="common-clj.schema.core.html"><div class="inner"><span>common-clj.schema.core</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="common-clj.schema.core.html#var-loose-schema"><div class="inner"><span>loose-schema</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">common-clj.schema.core</h1><div class="doc"><pre class="plaintext">Just common Clojure code that I use across projects.</pre></div><div class="public anchor" id="var-loose-schema"><h3>loose-schema</h3><div class="usage"><code>(loose-schema schema)</code></div><div class="doc"><pre class="plaintext">Takes a schema and convert is to a loose schema, so we can validate schemas that fulfils
+definition and accept more properties than defined initially.</pre></div></div></div></body></html>