Skip to content

Commit

Permalink
adding CODE_OF_CONDUCT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruce Hauman committed Jan 14, 2025
1 parent 6a32810 commit 493e2a8
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 11 deletions.
40 changes: 40 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Code of Conduct

## Our Pledge

We are committed to fostering a welcoming environment for everyone. We believe in creating a space where all participants feel respected, valued, and able to contribute.

## Expected Behavior

- **Be Respectful:** Treat everyone with kindness and consideration.
- **Be Open-Minded:** Welcome diverse perspectives and experiences.
- **Communicate Clearly:** Share your ideas thoughtfully and listen actively.
- **Collaborate Fairly:** Work together to achieve common goals.

## Unacceptable Behavior

While we aim to be permissive, the following behaviors are not acceptable:

- **Harassment:** Any form of discrimination, intimidation, or offensive behavior.
- **Disruption:** Actions that undermine the collaborative spirit or hinder others' contributions.
- **Inappropriate Content:** Sharing content that is obscene, hateful, or otherwise unsuitable.

## Reporting Issues

If you encounter behavior that violates this code:

1. **Reach Out:** Contact a project maintainer or community leader privately.
2. **Provide Details:** Share relevant information to help address the issue.
3. **Respect Privacy:** Respect the confidentiality of all parties involved.

## Enforcement

We trust our community members to uphold these standards. Depending on the situation, responses may include:

- **Warning:** A reminder of the expected behavior.
- **Discussion:** Open dialogue to resolve misunderstandings.
- **Removal:** In severe cases, removal from the community or project may occur.

---

*If you have any suggestions for improving this document, feel free to open a pull request or issue.*
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Figwheel Main
# Contributing to FigwheelMain

First off, thank you for considering contributing to [Figwheel Main](https://github.com/bhauman/figwheel-main)! 🎉 Your efforts are greatly appreciated and help make this project better for everyone.
First off, thank you for considering contributing to [FigwheelMain](https://github.com/bhauman/figwheel-main)! Your efforts are greatly appreciated and help make this project better for everyone.

## Table of Contents

Expand All @@ -22,23 +22,23 @@ Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a wel

## How Can I Contribute?

There are many ways to contribute to Figwheel Main, whether it's improving documentation, reporting issues, suggesting new features, or contributing code. Here's how you can get started:
There are many ways to contribute to FigwheelMain, whether it's improving documentation, reporting issues, suggesting new features, or contributing code. Here's how you can get started:

### Reporting Bugs

If you find a bug in Figwheel Main, please open an issue with the following information:
If you find a bug in FigwheelMain, please open an issue with the following information:

- **A clear and descriptive title**
- **A detailed description** of the problem
- **Steps to reproduce the issue**
- **Expected vs. actual behavior**
- **Environment information** (e.g., OS, version of Figwheel Main, etc.)
- **Environment information** (e.g., OS, version of FigwheelMain, etc.)

Before creating a new issue, please search existing issues to see if someone else has already reported the problem.

### Suggesting Enhancements

Have an idea to make Figwheel Main better? We'd love to hear it! When suggesting enhancements, please:
Have an idea to make FigwheelMain better? We'd love to hear it! When suggesting enhancements, please:

- Provide a clear and descriptive title
- Describe the enhancement in detail
Expand Down Expand Up @@ -164,7 +164,7 @@ Adhering to style guides improves readability and maintainability. Please follow
- **Line Length**: Keep lines under 80 characters where possible.
- **Whitespace**: Use blank lines to separate logical blocks of code.

Consider using tools like [cljfmt](https://github.com/weavejester/cljfmt) and [eastwood](https://github.com/jonase/eastwood) for automated formatting and linting.
Consider using tools like [cljfmt](https://github.com/weavejester/cljfmt) and for automated formatting and linting.

## Additional Notes

Expand All @@ -175,11 +175,9 @@ Consider using tools like [cljfmt](https://github.com/weavejester/cljfmt) and [e
git merge upstream/main
```
- **Ask Questions**: If you're unsure about something, feel free to [open an issue](https://github.com/bhauman/figwheel-main/issues) or join the community discussions.
- **Respect Licensing**: Ensure that your contributions comply with the project's licensing terms. Figwheel Main is licensed under the [Eclipse Public License](https://github.com/bhauman/figwheel-main/blob/main/LICENSE).
- **Respect Licensing**: Ensure that your contributions comply with the project's licensing terms. FigwheelMain is licensed under the [Eclipse Public License](https://github.com/bhauman/figwheel-main/blob/main/LICENSE).

Thank you again for your interest in contributing to Figwheel Main! Together, we can make this project even better.

Happy coding! 🚀
Thank you again for your interest in contributing to FigwheelMain!

# License

Expand Down

0 comments on commit 493e2a8

Please sign in to comment.