Skip to content

Latest commit

 

History

History
257 lines (171 loc) · 9.79 KB

CONTRIBUTING .md

File metadata and controls

257 lines (171 loc) · 9.79 KB

Contributing to AI Content Generator 🎯

First off, thanks for taking the time to contribute! This document explains the process and guidelines for contributing to the AI Content Generator repository.


Code of Conduct 📃

Please read and follow our Code of Conduct.


Star our Repository ⭐

Stars Forks Issues PRs Open PRs Closed


Need Help With The Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:


Table of Contents

  1. How Can I Contribute?
  2. Good Coding Practices
  3. Commit Message Guidelines
  4. Help And Support
  5. Setting Up Development Environment

How Can I Contribute?

First Pull Request ✨

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/ai-content-generator.git
  1. Navigate to the project directory
cd ai-content-generator
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your changes or addition of features inside this"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution

Alternatively, contribute using GitHub Desktop 🖥️

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

  • If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
  • Choose the project repository from the list of repositories on GitHub and clone it to your local machine.

3.Switch to the Correct Branch:

  • Ensure you are on the branch that you want to submit a pull request for.
  • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
  1. Make Changes:
  • Make your changes to the code or files in the repository using your preferred code editor.
  1. Commit Changes:
  • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
  • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.
  1. Push Changes to GitHub:
  • After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
  1. Create a Pull Request:
  • Go to the GitHub website and navigate to your fork of the project repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
  1. Review and Submit:
  • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
  • Once you're satisfied, click the "Create pull request" button to submit your pull request.
  1. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the project repository.

Submitting Pull Requests 🚀

If you're ready to submit code to fix an issue or add a new feature:

  1. Fork the repository and clone it locally.
  2. Create a new branch from the main branch for your changes.
  3. Make your changes with clear and atomic commits.
  4. Test your changes thoroughly.
  5. Push your branch to your forked repo and open a Pull Request (PR) on the original repo.
  6. Wait for feedback or approval from maintainers.

Reporting Issues 📌

If you've found a bug or have a suggestion for a new feature:

  1. Check existing issues to ensure it hasn’t been reported yet. Issues
  2. Create a new issue and provide detailed information:
    • A clear title.
    • Detailed steps to reproduce the bug (if applicable).
    • Any relevant screenshots or logs.
    • Your environment (e.g., operating system, version of the AI Content Generator).
  3. Use labels like bug, enhancement, question, etc. to categorize your issue.

Improving Documentation 📖

If you notice a typo, missing information, or outdated content in the documentation:

  1. Create an issue or submit a pull request directly with your changes.
  2. Ensure any new sections follow the existing documentation style.

Good Coding Practices 🧑‍💻

  1. Follow the Project's Code Style

    • Maintain consistency with the existing code style (indentation, spacing, comments).
    • Use meaningful and descriptive names for variables, functions, and classes.
    • Keep functions short and focused on a single task.
    • Avoid hardcoding values; instead, use constants or configuration files when possible.

  2. Write Clear and Concise Comments

    • Use comments to explain why you did something, not just what you did.
    • Avoid unnecessary comments that state the obvious.
    • Document complex logic and functions with brief explanations to help others understand your thought -process.

  3. Keep Code DRY (Don't Repeat Yourself)

    • Avoid duplicating code. Reuse functions, methods, and components whenever possible.
    • If you find yourself copying and pasting code, consider creating a new function or component.

  4. Write Tests

    • Write unit tests for your functions and components.
    • Ensure your tests cover both expected outcomes and edge cases.
    • Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.

  5. Code Reviews and Feedback

    • Be open to receiving constructive feedback from other contributors.
    • Conduct code reviews for others and provide meaningful suggestions to improve the code.
    • Always refactor your code based on feedback to meet the project's standards.

Commit Message Guidelines 📋

  • Use clear, descriptive commit messages.
  • Format:
    • Capitalize the first letter.
    • Use imperative mood ("Add feature", not "Added feature").
    • Keep the commit message concise (under 72 characters).

Example:

Add support for generating multiple content types
Fix issue with AI response timeout
Update documentation for installation instructions

For Help And Support 💬


Setting Up Development Environment 🔧

To get started with the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/iamkanhaiyakumar/ai-content-generator.git
    cd ai-content-generator

  2. Install dependencies (if applicable):

    npm install                      # For Node.js dependencies (if applicable)

  3. Run tests to ensure everything is set up properly:

    npm test    # If using JavaScript/Node.js

  4. Run the application to verify your environment setup:

    npm start         # For JavaScript-based projects

Thank you for contributing 💗

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀