Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a CONTRIBUTING.md and CODE_OF_CONDUCT.md #880

Merged
merged 4 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a welcoming and positive experience for everyone. We pledge to act
and interact in ways that contribute to an open, collaborative, and healthy
community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward others
- 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.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Contributing Guidelines

Thank you for your interest in contributing to this project! This document provides guidelines and instructions for contributing.

## Code of Conduct

By participating in this project, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing.

## How to Contribute

### Reporting Bugs

- Before creating a bug report, please check the existing issues to avoid duplicates
- When creating a bug report, include:
- A clear and descriptive title
- Detailed steps to reproduce the issue
- Expected behavior vs actual behavior
- Screenshots if applicable
- Your environment (OS, browser, version etc.)

### Suggesting Enhancements

- Use the issue tracker to suggest enhancements
- Clearly describe the feature and its use case
- Explain why this enhancement would be useful

### Pull Requests

1. Clone the repository
2. Create a new branch from `main` (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run tests if applicable
5. Commit your changes with a clear message (bonus points for [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)):

```sh
git commit -m 'Add: new feature X'
git commit -m 'Fix: issue with Y'
git commit -m 'Update: improve Z functionality'
```

6. Push to the branch (`git push origin feature/amazing-feature`)
7. Open a Pull Request against the `main` branch

#### Pull Request Guidelines

- All PRs must target the `main` branch
- Keep PRs small and focused on a single feature or fix
- If you find yourself changing multiple things, consider breaking it into separate PRs
- A good PR should be small enough to review in 10-15 minutes
- Follow the existing code style and conventions
- Include tests if adding new functionality
- Update documentation as needed
- Provide a clear description in your PR that explains:
- What changes you made
- Why you made these changes
- How to test the changes
- Any related issues (use "Fixes #123" or "Relates to #123")
- Add screenshots or GIFs if you made UI changes
- Make sure all tests pass before requesting review
- Respond to review comments promptly

## Development Setup

1. Clone the repository
2. Install dependencies with `yarn install`
3. Create a new branch for your changes
4. Make your changes
5. Test your changes locally
6. Submit a pull request

## Style Guidelines

- Follow existing code formatting
- Write clear, descriptive commit messages
- Comment your code when necessary
- Keep functions focused and modular

## Additional Resources

- [Project Documentation](README.md)
- [Issue Templates](.github/ISSUE_TEMPLATE)
- [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md)

## Questions?

If you have questions, feel free to open an issue or contact the maintainers.
Loading