diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..cb1cec1 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..41cf8b6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,110 @@ +# Contributing Guidelines + +We welcome contributions from the community! Please follow these guidelines to help maintain consistency and quality in the project. + +## Code of Conduct +This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold its terms. + +### Requirements +- Crystal 1.0+ +- Shards package manager +- SQLite3 + +## Local Development + +- linux +```bash +sudo apt-get update && sudo apt-get install -y crystal libssl-dev libsqlite3-dev +``` + +- macos +```bash +brew tap amberframework/micrate +brew install micrate +``` + +## Run +```bash +shards run bit +``` + +- Generate the `X-Api-Key` + +```bash +shards run cli -- --create-user=Admin +``` + +- Run tests + +```bash +ENV=test crystal spec +``` + + +## How to Contribute + +### 1. Fork the Repository +Click the "Fork" button at the top-right of the [repository page](https://github.com/sjdonado/bit). + +### 2. Clone Your Fork +```bash +git clone https://github.com/YOUR_USERNAME/bit.git +cd bit +``` + +### 3. Create a Feature Branch +```bash +git checkout -b feat/your-feature-name +``` + +### or for bug fixes: + +```bash +git checkout -b fix/issue-description +``` + +### 4. Develop Your Changes +- Ensure changes match the project scope +- Write clear commit messages +- Include tests for new functionality +- Update documentation when applicable + +### 5. Commit Changes +```bash +git commit -am 'Add descriptive commit message' +``` + +### 6. Push to GitHub +```bash +git push origin your-branch-name +``` + +### 7. Create a Pull Request +1. Go to the [original repository](https://github.com/sjdonado/bit) +2. Click "New Pull Request" +3. Select your fork and branch +4. Add a clear description including: + - Purpose of changes + - Related issues (if applicable) + - Testing performed + +## Pull Request Guidelines +- Keep PRs focused on a single feature/bugfix +- Ensure all tests pass +- Update documentation in the same PR +- Use descriptive titles (e.g., "Add URL validation" not "Update code") +- Reference related issues using #issue-number + +## Reporting Issues +When opening an issue, please include: +1. Description of the problem +2. Steps to reproduce +3. Expected vs actual behavior +4. Environment details (OS, Crystal version, etc) + +For feature requests: +- Explain the problem you're trying to solve +- Suggest potential implementations + +## License +By contributing, you agree that your contributions will be licensed under the project's [license](LICENSE.md).