From c9ee4d7a220a9418ca208dbfb84fa03621f7c39f Mon Sep 17 00:00:00 2001 From: Chris Valarida Date: Wed, 12 Feb 2025 12:37:16 -0800 Subject: [PATCH 1/4] First draft of CONTRIBUTING and CODE_OF_CONDUCT --- CODE_OF_CONDUCT.md | 54 ++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 127 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..6d7322bd3 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,54 @@ +# 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, caste, color, 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. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..49a9087bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,73 @@ +# 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 (`git checkout -b feature/amazing-feature`) +3. Make your changes +4. Run tests if applicable +5. Commit your changes (`git commit -m 'Add amazing feature'`) +6. Push to the branch (`git push origin feature/amazing-feature`) +7. Open a Pull Request + +#### Pull Request Guidelines + +- Follow the existing code style and conventions +- Include tests if adding new functionality +- Update documentation as needed +- One pull request per feature/fix +- Keep pull requests focused in scope + +## 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. + +## License + +By contributing, you agree that your contributions will be licensed under the project's license. From 5248b646a79a74a69e1f368afc164bf44abcbe71 Mon Sep 17 00:00:00 2001 From: Chris Valarida Date: Wed, 12 Feb 2025 13:54:04 -0800 Subject: [PATCH 2/4] Add more details to the PR guidelines --- CONTRIBUTING.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49a9087bf..710b0be8a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,20 +27,37 @@ By participating in this project, you agree to follow our [Code of Conduct](CODE ### Pull Requests 1. Clone the repository -2. Create a new branch (`git checkout -b feature/amazing-feature`) +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 (`git commit -m 'Add amazing feature'`) +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 +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 -- One pull request per feature/fix -- Keep pull requests focused in scope +- 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 From 144c0a2277ec8a438f314ca0f093d7acdd0d76b1 Mon Sep 17 00:00:00 2001 From: Chris Valarida Date: Wed, 12 Feb 2025 14:12:37 -0800 Subject: [PATCH 3/4] Nix a couple sections --- CODE_OF_CONDUCT.md | 5 ----- CONTRIBUTING.md | 4 ---- 2 files changed, 9 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 6d7322bd3..da29b4d74 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -47,8 +47,3 @@ or harmful. This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 710b0be8a..3c0070bc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,7 +84,3 @@ By participating in this project, you agree to follow our [Code of Conduct](CODE ## Questions? If you have questions, feel free to open an issue or contact the maintainers. - -## License - -By contributing, you agree that your contributions will be licensed under the project's license. From 6926320722fbec937e767a64b4f3e6f218a3a4b8 Mon Sep 17 00:00:00 2001 From: Chris Valarida Date: Wed, 12 Feb 2025 14:32:22 -0800 Subject: [PATCH 4/4] Be more generic --- CODE_OF_CONDUCT.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index da29b4d74..913f99f9f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -3,21 +3,16 @@ ## 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, caste, color, 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. +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 other people +- 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,