Skip to content

Commit

Permalink
chore: add code of conduct and contributing md files (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
drgsn authored Dec 28, 2024
1 parent 5757dc6 commit 87bc168
Show file tree
Hide file tree
Showing 2 changed files with 257 additions and 0 deletions.
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# 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 e-mail 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
.
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.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
129 changes: 129 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Contributing to FileFusion 🚀

First off, thank you for considering contributing to FileFusion! It's people like you that make OSS Community great.

## Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [project maintainers].

## How Can I Contribute?

### Reporting Bugs 🐛

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

- Use a clear and descriptive title
- Describe the exact steps which reproduce the problem
- Provide specific examples to demonstrate the steps
- Describe the behavior you observed after following the steps
- Explain which behavior you expected to see instead and why
- Include details about your configuration and environment

### Suggesting Enhancements ✨

If you have a suggestion for the project, we want to hear it! Before creating enhancement suggestions, please check the issue list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible:

- Use a clear and descriptive title
- Provide a step-by-step description of the suggested enhancement
- Provide specific examples to demonstrate the steps
- Describe the current behavior and explain which behavior you expected to see instead and why
- Explain why this enhancement would be useful to most FileFusion users

### Pull Requests 💪

Please follow these steps to have your contribution considered by the maintainers:

1. Follow all instructions in the template
2. Follow the [style guides](#style-guides)
3. After you submit your pull request, verify that all status checks are passing

#### Local Development Setup

1. Fork the repo
2. Clone your fork

```bash
git clone https://github.com/your-username/filefusion.git
```

3. Set up your development environment:

```bash
cd filefusion
go mod download
```

4. Create a new branch:

```bash
git checkout -b feature/your-feature-name
```

### Style Guides 📝

#### Git Commit Messages

Each commit message should consist of a clear description of the change, with a reference to the GitHub issue number if applicable.
Format: [gh-{issue-number}:] {commit description}

#### Examples:

- gh-123: Add support for YAML output format
- gh-45: Fix file size calculation for large files
- Add contributing guidelines (when no related issue exists)

#### Guidelines:

- Start with the issue reference if one exists
- Use clear and concise descriptions
- Keep the first line under 72 characters
- Use the present tense
- Add additional details in the commit body if needed

### Go Code Style Guide

- Follow standard Go conventions and format your code with `gofmt`
- Write descriptive variable and function names
- Add comments for complex logic
- Follow the principles in [Effective Go](https://golang.org/doc/effective_go.html)
- Use `golangci-lint` for linting

### Documentation 📚

- Update the README.md with details of changes to the interface
- Update the Wiki with any necessary changes
- Add or update code comments as needed

### Testing 🧪

- Write test cases for new features
- Ensure existing tests pass
- Follow table-driven test patterns when appropriate
- Aim for high test coverage

### Continuous Integration ⚙️

We use GitHub Actions for our CI pipeline. Ensure your changes:

- Pass all existing tests
- Pass lint checks
- Meet coverage requirements
- Don't introduce new warnings

## Community 🌍

- Follow the project's development
- Share FileFusion in your network
- Help others in the issues section

## Questions? 💭

Don't hesitate to ask questions about contributing. You can:

- Open an issue with your question
- Reach out to the maintainers
- Join community discussions

---

Again, thank you for your interest in contributing to FileFusion! ❤️

0 comments on commit 87bc168

Please sign in to comment.