-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from Bridgetamana/feature/contributing-file
added contributing file
- Loading branch information
Showing
2 changed files
with
145 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others’ private information, such as a physical or electronic address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all project spaces and it also applies when an individual is representing the project or its community in public spaces. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [adam.webtools@gmail.com](mailto:adam.webtools@gmail.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq. |
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,104 @@ | ||
# Contributing to ai-helper-tools | ||
|
||
Thank you for considering contributing to Gemini tools! We welcome contributions from everyone. Here’s a guide to help you get started. | ||
|
||
## Table of Contents | ||
|
||
1. [Code of Conduct](#code-of-conduct) | ||
2. [How to Contribute](#how-to-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Suggesting Features](#suggesting-features) | ||
- [Submitting Code Changes](#submitting-code-changes) | ||
3. [Development Workflow](#development-workflow) | ||
4. [Style Guides](#style-guides) | ||
5. [Getting Help](#getting-help) | ||
|
||
## Code of Conduct | ||
|
||
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md) to foster an open and welcoming environment. By participating, you agree to uphold this code. Report any issues to [adam.webtools@gmail.com](mailto:adam.webtools@gmail.com). | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs | ||
|
||
To report a bug, please open an issue with: | ||
|
||
- A clear and descriptive title. | ||
- Steps to reproduce the issue. | ||
- Expected vs. actual results. | ||
- Screenshots or logs if available. | ||
|
||
### Suggesting Features | ||
|
||
To suggest a feature, please: | ||
|
||
1. Search for existing suggestions. | ||
2. If none exist, open an issue with: | ||
- A clear title and detailed description. | ||
- The problem it solves. | ||
- Examples or references. | ||
|
||
### Submitting Code Changes | ||
|
||
For code contributions: | ||
|
||
1. Fork the repository. | ||
2. Create a branch (`git checkout -b feature/your-feature-name`). | ||
3. Make your changes. | ||
4. Test thoroughly. | ||
5. Commit and push (`git commit -m 'Add new feature'` and `git push origin feature/your-feature-name`). | ||
6. Open a pull request. | ||
|
||
## Development Workflow | ||
|
||
1. **Fork and Clone**: | ||
```bash | ||
git clone https://github.com/Bashamega/ai-helper-tools.git | ||
cd ai-helper-tools | ||
``` | ||
2. **Install Dependencies**: | ||
```bash | ||
npm install | ||
``` | ||
3. **Copy `.env.example` to `.env`**: | ||
```bash | ||
cp .env.example .env | ||
``` | ||
|
||
4. **Add Your API Key**: | ||
- Open the `.env` file in a text editor. | ||
- Replace the placeholder in `NEXT_PUBLIC_API_KEY=""` with your actual API key. | ||
``` | ||
NEXT_PUBLIC_API_KEY="your_actual_api_key_here" | ||
``` | ||
5. **Run Development Server**: | ||
- Save the `.env` file after editing it. | ||
- You can now proceed to run the development server using `npm run dev`. | ||
```bash | ||
npm run dev | ||
``` | ||
|
||
## Style Guides | ||
|
||
### Code Style | ||
|
||
- Follow the existing coding standards. | ||
- Use meaningful names for variables and functions. | ||
- Keep functions small and focused. | ||
|
||
### Documentation Style | ||
|
||
- Write clear comments. | ||
- Document important functions and classes. | ||
- Update README.md as necessary. | ||
|
||
## Getting Help | ||
|
||
For help, you can: | ||
|
||
- Review the documentation. | ||
- Check existing issues and pull requests. | ||
- Reach out via discussions. | ||
|
||
Thank you for contributing to ai-helper-tools! Your help is greatly appreciated. |