Skip to content

Commit d55dbe0

Browse files
sjdonadosjdonado
authored
Merge pull request #4 from sjdonado/chore/documentation
Chore/documentation
2 parents a271e7c + 55969b0 commit d55dbe0

File tree

6 files changed

+522
-282
lines changed

6 files changed

+522
-282
lines changed

‎.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
/docs/
21
/lib/
32
/bin/
43
/.shards/

‎CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Contributing Guidelines
2+
3+
We welcome contributions from the community! Please follow these guidelines to help maintain consistency and quality in the project.
4+
5+
## Code of Conduct
6+
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold its terms.
7+
8+
### Requirements
9+
- Crystal 1.0+
10+
- Shards package manager
11+
- SQLite3
12+
13+
## Local Development
14+
15+
- linux
16+
```bash
17+
sudo apt-get update && sudo apt-get install -y crystal libssl-dev libsqlite3-dev
18+
```
19+
20+
- macos
21+
```bash
22+
brew tap amberframework/micrate
23+
brew install micrate
24+
```
25+
26+
## Run
27+
```bash
28+
shards run bit
29+
```
30+
31+
- Generate the `X-Api-Key`
32+
33+
```bash
34+
shards run cli -- --create-user=Admin
35+
```
36+
37+
- Run tests
38+
39+
```bash
40+
ENV=test crystal spec
41+
```
42+
43+
44+
## How to Contribute
45+
46+
### 1. Fork the Repository
47+
Click the "Fork" button at the top-right of the [repository page](https://github.com/sjdonado/bit).
48+
49+
### 2. Clone Your Fork
50+
```bash
51+
git clone https://github.com/YOUR_USERNAME/bit.git
52+
cd bit
53+
```
54+
55+
### 3. Create a Feature Branch
56+
```bash
57+
git checkout -b feat/your-feature-name
58+
```
59+
60+
### or for bug fixes:
61+
62+
```bash
63+
git checkout -b fix/issue-description
64+
```
65+
66+
### 4. Develop Your Changes
67+
- Ensure changes match the project scope
68+
- Write clear commit messages
69+
- Include tests for new functionality
70+
- Update documentation when applicable
71+
72+
### 5. Commit Changes
73+
```bash
74+
git commit -am 'Add descriptive commit message'
75+
```
76+
77+
### 6. Push to GitHub
78+
```bash
79+
git push origin your-branch-name
80+
```
81+
82+
### 7. Create a Pull Request
83+
1. Go to the [original repository](https://github.com/sjdonado/bit)
84+
2. Click "New Pull Request"
85+
3. Select your fork and branch
86+
4. Add a clear description including:
87+
- Purpose of changes
88+
- Related issues (if applicable)
89+
- Testing performed
90+
91+
## Pull Request Guidelines
92+
- Keep PRs focused on a single feature/bugfix
93+
- Ensure all tests pass
94+
- Update documentation in the same PR
95+
- Use descriptive titles (e.g., "Add URL validation" not "Update code")
96+
- Reference related issues using #issue-number
97+
98+
## Reporting Issues
99+
When opening an issue, please include:
100+
1. Description of the problem
101+
2. Steps to reproduce
102+
3. Expected vs actual behavior
103+
4. Environment details (OS, Crystal version, etc)
104+
105+
For feature requests:
106+
- Explain the problem you're trying to solve
107+
- Suggest potential implementations
108+
109+
## License
110+
By contributing, you agree that your contributions will be licensed under the [license](LICENSE).

0 commit comments

Comments
 (0)