From 5009b4d0070fcb60420fb627dcbc943364ba68ff Mon Sep 17 00:00:00 2001 From: erp12 Date: Mon, 13 Sep 2021 22:59:47 -0400 Subject: [PATCH] Rebuild docs --- CODE_OF_CONDUCT.md | 80 +++++++- CONTRIBUTING.md | 73 ++++++- doc_src/code_of_conduct.md | 80 -------- doc_src/contributing.md | 73 ------- doc_src/faq.md | 2 +- docs/changelog.html | 2 +- docs/code_of_conduct.html | 34 ---- docs/contributing.html | 44 ---- docs/erp12.fijit.alpha.reflect.html | 9 +- docs/erp12.fijit.collection.html | 2 +- docs/erp12.fijit.core.html | 2 +- docs/erp12.fijit.function.Function0.html | 3 - docs/erp12.fijit.function.Function1.html | 3 - docs/erp12.fijit.function.Function2.html | 3 - docs/erp12.fijit.function.Function3.html | 3 - docs/erp12.fijit.function.html | 2 +- docs/erp12.fijit.function.util.html | 3 - docs/erp12.fijit.meta.html | 25 --- docs/erp12.fijit.option.html | 2 +- docs/erp12.fijit.reflect.core.html | 3 - docs/erp12.fijit.reflect.html | 21 -- docs/erp12.fijit.reflect.tag.html | 3 - docs/erp12.fijit.reflect.tree.html | 3 - docs/erp12.fijit.try.html | 2 +- docs/erp12.fijit.tuple.html | 6 +- docs/erp12.fijit.version.html | 4 +- docs/faq.html | 16 +- docs/guide.html | 243 +++++++++++++++++++++-- docs/index.html | 2 +- 29 files changed, 408 insertions(+), 340 deletions(-) delete mode 100644 doc_src/code_of_conduct.md delete mode 100644 doc_src/contributing.md delete mode 100644 docs/code_of_conduct.html delete mode 100644 docs/contributing.html delete mode 100644 docs/erp12.fijit.function.Function0.html delete mode 100644 docs/erp12.fijit.function.Function1.html delete mode 100644 docs/erp12.fijit.function.Function2.html delete mode 100644 docs/erp12.fijit.function.Function3.html delete mode 100644 docs/erp12.fijit.function.util.html delete mode 100644 docs/erp12.fijit.meta.html delete mode 100644 docs/erp12.fijit.reflect.core.html delete mode 100644 docs/erp12.fijit.reflect.html delete mode 100644 docs/erp12.fijit.reflect.tag.html delete mode 100644 docs/erp12.fijit.reflect.tree.html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e4b8309..29e562a 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1 +1,79 @@ -Please read our [Code of Conduct](erp12.github.io/fijit/code_of_conduct.html) on the official Fijit page. \ No newline at end of file +# Code of Conduct + +These community rules are put in place in order to ensure that development of Fijit stays +focused and productive. + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported anonymously using [this form](https://forms.gle/H6xZvCcaCDYc2FFi8). All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e39c69..e568d3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,72 @@ -Please read the Fijit [contributing guide](erp12.github.io/fijit/contributing.html) on the official Fijit page. \ No newline at end of file +# Contributing to Fijit + +All interest in Fijit, as a user or contributor, is greatly appreciated! This document +will go into detail on how to contribute to the development of fijit. + +## Before Contributing + +Before reading further we ask that you read our [Code of Conduct](https://github.com/erp12/fijit/blob/master/CODE_OF_CONDUCT.md) +which will be enforced by the maintainers in order to ensure that development of Fijit stays focused and productive. + +If you are new to contributing to open source, or GitHub, the following links may be helpful starting places: + +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +- [Understanding the GitHub flow](https://guides.github.com/introduction/flow/index.html) + +### We Use Github Flow + +This means that all code and documentation changes happen through pull requests. We actively welcome your pull requests: + +1. Fork the repo and create your branch from `master`. +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. + +### Any contributions you make will be under the MIT Software License + +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. +Feel free to contact the maintainers if that's a concern. + +# How to contribute a ... + +## Bug Report + +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](). + +**Great Bug Reports** tend to have at least the following: + +- A quick summary and/or background +- The steps to reproduce. +- When possible, minimal code that reproduces the bug. +- A description of what you expected versus what actually happens. + +## Feature Request + +We like to hear in all feature requests and discussion around the direction of the project. The best place +to discuss future features is the project's [discussion page](https://github.com/erp12/fijit/discussions) under +the [Fijit](https://github.com/erp12/fijit/discussions/categories/fijit) category. + +## Bug fix, new feature, documentation improvement, or other change. + +We welcome contribution to the codebase via pull requests. In most cases, it is beneficial to discuss your change +with the community via a GitHub issue or discussion before working on a pull request. Once you decide to work on a +pull request, please follow the workflow outlined in the above sections. + +Once you own the pull request, it will be tested with by CI and reviewed by other contributors (including at least one +project maintainer). After all iterations of review are finished, one of the project maintainers will merge +your pull request. + +## Running Tests + +When working on a code change or addition to Fijit, it is expected that all changes pass existing tests and probably +introduce new tests to ensure stability of future changes. + +Because Fijit aims to be compatible across a range of Scala versions, the project uses a test matrix that runs the test +suite multiple times (once per Scala version). This is implemented in the `build.clj`. + +To run the test across all Scala versions, use the following command using the `clj` command line interface: + +```commandline +clj -T:build tests +``` diff --git a/doc_src/code_of_conduct.md b/doc_src/code_of_conduct.md deleted file mode 100644 index 664410f..0000000 --- a/doc_src/code_of_conduct.md +++ /dev/null @@ -1,80 +0,0 @@ - -# Code of Conduct - -These community rules are put in place in order to ensure that development of Fijit stays -focused and productive. - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to make participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies within all project spaces, and it also applies when -an individual is representing the project or its community in public spaces. -Examples of representing a project or community include using an official -project e-mail address, posting via an official social media account, or acting -as an appointed representative at an online or offline event. Representation of -a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported anonymously using [this form](https://forms.gle/H6xZvCcaCDYc2FFi8). All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/doc_src/contributing.md b/doc_src/contributing.md deleted file mode 100644 index c6d5140..0000000 --- a/doc_src/contributing.md +++ /dev/null @@ -1,73 +0,0 @@ -# Contributing to Fijit - -All interest in Fijit, as a user or contributor, is greatly appreciated! It make - -## Before Contributing - -This document will go into detail on how to contribute to the development. - -Before reading further we ask that you read our [Code of Conduct](erp12.github.io/fijit/code_of_conduct.html) -which will be enforced by the maintainers in order to ensure that development of Fijit stays focused and productive. - -If you are new to contributing to open source, or GitHub, the following links may be helpful starting places: - -- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) -- [Understanding the GitHub flow](https://guides.github.com/introduction/flow/index.html) - -### We Use Github Flow - -This means that all code and documentation changes happen through pull requests. We actively welcome your pull requests: - -1. Fork the repo and create your branch from `master`. -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. - -### Any contributions you make will be under the MIT Software License - -In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. -Feel free to contact the maintainers if that's a concern. - -# How to contribute a ... - -## Bug Report - -We use GitHub issues to track public bugs. Report a bug by [opening a new issue](). - -**Great Bug Reports** tend to have at least the following: - -- A quick summary and/or background -- The steps to reproduce. -- When possible, minimal code that reproduces the bug. -- A description of what you expected versus what actually happens. - -## Feature Request - -We like to hear in all feature requests and discussion around the direction of the project. The best place -to discuss future features is the project's [discussion page](https://github.com/erp12/fijit/discussions) under -the [Fijit](https://github.com/erp12/fijit/discussions/categories/fijit) category. - -## Bug fix, new feature, documentation improvement, or other change. - -We welcome contribution to the codebase via pull requests. In most cases, it is beneficial to discuss your change -with the community via a GitHub issue or discussion before working on a pull request. Once you decide to work on a -pull request, please follow the workflow outlined in the above sections. - -Once you own the pull request, it will be tested with by CI and reviewed by other contributors (including at least one -project maintainer). After all iterations of review are finished, one of the project maintainers will merge -your pull request. - -## Running Tests - -When working on a code change or addition to Fijit, it is expected that all changes pass existing tests and probably -introduce new tests to ensure stability of future changes. - -Because Fijit aims to be compatible across a range of Scala versions, the project uses a test matrix that runs the test -suite multiple times (once per Scala version). This is implemented in the `build.clj`. - -To run the test across all Scala versions, use the following command using the `clj` command line interface: - -```commandline -clj -T:build tests -``` diff --git a/doc_src/faq.md b/doc_src/faq.md index c729b4f..36c6bb3 100644 --- a/doc_src/faq.md +++ b/doc_src/faq.md @@ -12,7 +12,7 @@ That said, fijit already leverages macros to delegate to different implementatio It is possible that a Scala 3 implementation is possible for the entire fijit API, it is possible that one day fijit could support Scala 3. -If you are inclined to help with this effort, please see the [contributing guide](erp12.github.io/fijit/contributing.html). +If you are inclined to help with this effort, please see the [contributing guide](https://github.com/erp12/fijit/blob/master/CONTRIBUTING.md). ## Why the name "fijit"? diff --git a/docs/changelog.html b/docs/changelog.html index ec2abb7..47540c5 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -1,6 +1,6 @@ -Changelog

Project

Topics

Namespaces

Changelog

+Changelog

Project

Topics

Namespaces

Changelog

v1.0 - Initial Release