Skip to content

Commit 5009b4d

Browse files
committed
Rebuild docs
1 parent 48fa81d commit 5009b4d

29 files changed

+408
-340
lines changed

CODE_OF_CONDUCT.md

+79-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,79 @@
1-
Please read our [Code of Conduct](erp12.github.io/fijit/code_of_conduct.html) on the official Fijit page.
1+
# Code of Conduct
2+
3+
These community rules are put in place in order to ensure that development of Fijit stays
4+
focused and productive.
5+
6+
## Our Pledge
7+
8+
In the interest of fostering an open and welcoming environment, we as
9+
contributors and maintainers pledge to make participation in our project and
10+
our community a harassment-free experience for everyone, regardless of age, body
11+
size, disability, ethnicity, sex characteristics, gender identity and expression,
12+
level of experience, education, socio-economic status, nationality, personal
13+
appearance, race, religion, or sexual identity and orientation.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to creating a positive environment
18+
include:
19+
20+
* Using welcoming and inclusive language
21+
* Being respectful of differing viewpoints and experiences
22+
* Gracefully accepting constructive criticism
23+
* Focusing on what is best for the community
24+
* Showing empathy towards other community members
25+
26+
Examples of unacceptable behavior by participants include:
27+
28+
* The use of sexualized language or imagery and unwelcome sexual attention or
29+
advances
30+
* Trolling, insulting/derogatory comments, and personal or political attacks
31+
* Public or private harassment
32+
* Publishing others' private information, such as a physical or electronic
33+
address, without explicit permission
34+
* Other conduct which could reasonably be considered inappropriate in a
35+
professional setting
36+
37+
## Our Responsibilities
38+
39+
Project maintainers are responsible for clarifying the standards of acceptable
40+
behavior and are expected to take appropriate and fair corrective action in
41+
response to any instances of unacceptable behavior.
42+
43+
Project maintainers have the right and responsibility to remove, edit, or
44+
reject comments, commits, code, wiki edits, issues, and other contributions
45+
that are not aligned to this Code of Conduct, or to ban temporarily or
46+
permanently any contributor for other behaviors that they deem inappropriate,
47+
threatening, offensive, or harmful.
48+
49+
## Scope
50+
51+
This Code of Conduct applies within all project spaces, and it also applies when
52+
an individual is representing the project or its community in public spaces.
53+
Examples of representing a project or community include using an official
54+
project e-mail address, posting via an official social media account, or acting
55+
as an appointed representative at an online or offline event. Representation of
56+
a project may be further defined and clarified by project maintainers.
57+
58+
## Enforcement
59+
60+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
61+
reported anonymously using [this form](https://forms.gle/H6xZvCcaCDYc2FFi8). All
62+
complaints will be reviewed and investigated and will result in a response that
63+
is deemed necessary and appropriate to the circumstances. The project team is
64+
obligated to maintain confidentiality with regard to the reporter of an incident.
65+
Further details of specific enforcement policies may be posted separately.
66+
67+
Project maintainers who do not follow or enforce the Code of Conduct in good
68+
faith may face temporary or permanent repercussions as determined by other
69+
members of the project's leadership.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
74+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
75+
76+
[homepage]: https://www.contributor-covenant.org
77+
78+
For answers to common questions about this code of conduct, see
79+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+72-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,72 @@
1-
Please read the Fijit [contributing guide](erp12.github.io/fijit/contributing.html) on the official Fijit page.
1+
# Contributing to Fijit
2+
3+
All interest in Fijit, as a user or contributor, is greatly appreciated! This document
4+
will go into detail on how to contribute to the development of fijit.
5+
6+
## Before Contributing
7+
8+
Before reading further we ask that you read our [Code of Conduct](https://github.com/erp12/fijit/blob/master/CODE_OF_CONDUCT.md)
9+
which will be enforced by the maintainers in order to ensure that development of Fijit stays focused and productive.
10+
11+
If you are new to contributing to open source, or GitHub, the following links may be helpful starting places:
12+
13+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
14+
- [Understanding the GitHub flow](https://guides.github.com/introduction/flow/index.html)
15+
16+
### We Use Github Flow
17+
18+
This means that all code and documentation changes happen through pull requests. We actively welcome your pull requests:
19+
20+
1. Fork the repo and create your branch from `master`.
21+
2. If you've added code that should be tested, add tests.
22+
3. If you've changed APIs, update the documentation.
23+
4. Ensure the test suite passes.
24+
5. Create the pull request.
25+
26+
### Any contributions you make will be under the MIT Software License
27+
28+
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.
29+
Feel free to contact the maintainers if that's a concern.
30+
31+
# How to contribute a ...
32+
33+
## Bug Report
34+
35+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue]().
36+
37+
**Great Bug Reports** tend to have at least the following:
38+
39+
- A quick summary and/or background
40+
- The steps to reproduce.
41+
- When possible, minimal code that reproduces the bug.
42+
- A description of what you expected versus what actually happens.
43+
44+
## Feature Request
45+
46+
We like to hear in all feature requests and discussion around the direction of the project. The best place
47+
to discuss future features is the project's [discussion page](https://github.com/erp12/fijit/discussions) under
48+
the [Fijit](https://github.com/erp12/fijit/discussions/categories/fijit) category.
49+
50+
## Bug fix, new feature, documentation improvement, or other change.
51+
52+
We welcome contribution to the codebase via pull requests. In most cases, it is beneficial to discuss your change
53+
with the community via a GitHub issue or discussion before working on a pull request. Once you decide to work on a
54+
pull request, please follow the workflow outlined in the above sections.
55+
56+
Once you own the pull request, it will be tested with by CI and reviewed by other contributors (including at least one
57+
project maintainer). After all iterations of review are finished, one of the project maintainers will merge
58+
your pull request.
59+
60+
## Running Tests
61+
62+
When working on a code change or addition to Fijit, it is expected that all changes pass existing tests and probably
63+
introduce new tests to ensure stability of future changes.
64+
65+
Because Fijit aims to be compatible across a range of Scala versions, the project uses a test matrix that runs the test
66+
suite multiple times (once per Scala version). This is implemented in the `build.clj`.
67+
68+
To run the test across all Scala versions, use the following command using the `clj` command line interface:
69+
70+
```commandline
71+
clj -T:build tests
72+
```

doc_src/code_of_conduct.md

-80
This file was deleted.

doc_src/contributing.md

-73
This file was deleted.

doc_src/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ That said, fijit already leverages macros to delegate to different implementatio
1212
It is possible that a Scala 3 implementation is possible for the entire fijit API, it is possible that one day fijit
1313
could support Scala 3.
1414

15-
If you are inclined to help with this effort, please see the [contributing guide](erp12.github.io/fijit/contributing.html).
15+
If you are inclined to help with this effort, please see the [contributing guide](https://github.com/erp12/fijit/blob/master/CONTRIBUTING.md).
1616

1717
## Why the name "fijit"?
1818

0 commit comments

Comments
 (0)