-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
67b9b3d
commit 12414c4
Showing
3 changed files
with
202 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
[email protected]. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# 🎉 Welcome to UNITE! 🎉 | ||
|
||
Thank you for considering contributing to UNITE! We’re thrilled to have you here and can’t wait to see the amazing things we can build together. This project aims to create a social service platform where users can offer or receive various types of social work! 🚀 | ||
|
||
Let's unite our efforts to make a positive impact on the community. Whether you're here to develop new features, fix bugs, improve documentation, or share ideas, your contributions are highly valued. | ||
|
||
Together, we can make UNITE a powerful tool for social good. Happy contributing! ❤️ | ||
|
||
## How You Can Contribute | ||
|
||
Ready to jump in? Follow these steps to start contributing: | ||
|
||
1. **Fork the Repository 🍴** | ||
- Click the "Fork" button at the top of the page to fork the repository to your GitHub account. | ||
|
||
2. **Clone Your Fork 🖥️** | ||
- Clone your forked repository to your local machine using: | ||
```bash | ||
git clone https://github.com/Bug-Bust3rs/UNITE | ||
``` | ||
|
||
3. **Create a Branch (Mandatory) 🌿** | ||
- It’s mandatory to create a new branch for your changes. Don’t make changes directly to the `master` branch of your fork. Create a new branch with: | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
## Important Ways to Contribute | ||
|
||
Here are some key areas where you can make a difference: | ||
|
||
a. **Add a New Feature in Frontend ✨** | ||
- We’re always looking to expand our library of frontend components. If you have a cool feature or component that isn’t currently covered, feel free to create and contribute it. Ensure your contribution is well-documented and follows our coding standards. | ||
|
||
*If you want to add a new frontend feature, please place it inside the `apps/frontend` directory.* | ||
|
||
b. **Add a New Feature in Backend 🚀** | ||
- Have an idea for improving our backend? Whether it’s optimizing code, adding new endpoints, or enhancing existing ones, we’d love your input. Contributions can include performance tweaks, better documentation, or any other improvements you can think of. | ||
|
||
*If you want to enhance existing backend features or APIs, please work inside the `apps/backend` directories.* | ||
|
||
c. **Fix Bugs in Website 🐛** | ||
- Our website helps users understand and use UNITE. You can contribute by fixing bugs, adding new features, or improving the overall design and user experience. If you’re skilled in frontend development, we’d love your help here! | ||
|
||
*If you want to contribute to the UNITE documentation, please work inside the `docs` directory. The `apps/frontend` subdirectory is for the React js frontend and the `apps/backend` subdirectory is for the Node.js Express backend.* | ||
|
||
4. **Make Your Changes 💻** | ||
- Implement your changes in your new branch. Ensure your code follows the project's coding standards and is well-documented. | ||
5. **Commit and Push 🚢** | ||
- Commit your changes with a clear and descriptive commit message: | ||
```bash | ||
git commit -m "Description of your changes" | ||
``` | ||
- Push your changes to your forked repository: | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
6. **Create a Pull Request 🔄** | ||
- Head back to the original repository on GitHub and create a pull request from your branch. Provide a detailed description of your changes and why they should be merged. | ||
## Code of Conduct ❤️ | ||
Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code. If you notice any unacceptable behavior, please report it to the project maintainers. | ||
Thank you for your contributions and for helping to make Create My-API better! We’re excited to see what you come up with. | ||
## Contact 📬 | ||
If you have any questions, feel free to open an issue or reach out to the project maintainers. | ||
Happy coding! ✨ |