Gix Gitbook refs

talyssonoc · Mar 19, 2020 · 6e5f48c · 6e5f48c
1 parent 935305a
commit 6e5f48c
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 51 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -1,3 +1,3 @@
 structure:
-  readme: README.md
+  readme: packages/structure/README.md
   summary: docs/SUMMARY.md
diff --git a/contributing.md b/contributing.md
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1 @@
+./packages/structure/contributing.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,6 +1,6 @@
 # Table of contents
 
-- [Introduction](../README.md)
+- [Introduction](../packages/structure/README.md)
 - [Schema concept](schema-concept/README.md)
   - [Shorthand and complete type descriptor](schema-concept/shorthand-and-complete-type-descriptor.md)
   - [Circular reference](schema-concept/circular-references-and-dynamic-types.md)
@@ -24,7 +24,7 @@
 - [Strict mode](strict-mode.md)
 - [Cloning an instance](cloning.md)
 - [Serialization](serialization.md)
-- [Changelog](../CHANGELOG.md)
-- [Contributing](../contributing.md)
-- [License](../license.md)
+- [Changelog](../packages/structure/CHANGELOG.md)
+- [Contributing](../packages/structure/contributing.md)
+- [License](../packages/structure/license.md)
 - [GitHub](https://github.com/talyssonoc/structure)
diff --git a/license.md b/license.md
diff --git a/license.md b/license.md
@@ -0,0 +1 @@
+./packages/structure/license.md
diff --git a/packages/structure/contributing.md b/packages/structure/contributing.md
@@ -0,0 +1,25 @@
+# Contributing
+
+Contributions are always welcome! When contributing to Structure we ask you to follow our code of conduct:
+
+## Code of conduct
+
+In short: _Be nice_. Pay attention to the fact that Structure is free software, don't be rude with the contributors or with people with doubts and we'll be more than glad on helping you. Destructive criticism and demanding will be ignored.
+
+## Opening issues
+
+When opening an issue be descriptive about the bug or the feature suggestion, don't simply paste the error message on the issue title or description. Also, __provide code to simulate the bug__, we need to know the exact circumstances in which the bug occurs. Again, follow our [code of conduct](#code-of-conduct).
+
+## Pull requests
+
+When opening a pull request to Structure, follow this steps:
+
+1. Fork Structure;
+2. Create a new branch for your changes;
+3. Do your changes;
+4. Write tests for your changes;
+5. Check the coverage;
+6. Open the pull request;
+7. Write a complete description about the bug or the feature the pull request is about.
+
+Be aware that we keep __100% of code coverage__, any change that makes the code coverage less than 100% covered will be requested to write more tests.
diff --git a/packages/structure/license.md b/packages/structure/license.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Structure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.