Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

60 lines (47 loc) · 2.64 KB
Raw

Contributing Guidelines

Welcome to our project! We’re excited to have you here. Please read through the following guidelines to help you understand how to interact with our community and contribute effectively.

How to Contribute

  • Make sure your code follows our coding standards. We recommend using consistent formatting and naming conventions.
  • Test your code thoroughly before submitting a pull request to ensure that it does not introduce new bugs.
  • Include comments in your code to explain complex logic or assumptions.
  • Check the issues page for good-first-issue and hacktoberfest labels. These are beginner-friendly and great for new contributors.

Coding Standards

  • Use meaningful variable names that explain their purpose.
  • Ensure functions and methods are self-explanatory.
  • Avoid using hardcoded values. Use constants or configuration files where necessary.
  • Follow JavaScript ES6+ conventions and make use of arrow functions, const and let for variable declarations.

Step-by-Step Guide to Contribute

  1. Fork the repository by clicking on the Fork button at the top-right corner of the project page.
  2. Clone your forked repository to your local machine using: 
    git clone https://github.com/YOUR-USERNAME/promt-save-reuse-chatgpt-and-gemini.git
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes in this new branch. Follow the coding standards and comment where necessary.
  5. Stage your changes: 
    git add .
  6. Commit your changes with a meaningful message: 
    git commit -m "Add: Detailed description of what you changed"
  7. Push to your forked repository: 
    git push origin feature/your-feature-name
  8. Go to the original repository and open a Pull Request by clicking the Compare & pull request button.
  9. Fill in the pull request template and link it to the issue you are solving (if applicable).
  10. Wait for review and address any feedback provided by maintainers.

Reporting Issues

  • Use clear, descriptive titles and provide all necessary information when reporting issues.
  • Include screenshots or code snippets if it helps illustrate the problem.
  • Be respectful and constructive in your feedback.

Respectful Communication

  • Always be respectful and considerate in your interactions.
  • Avoid any discriminatory or inappropriate language.

Thank You!

Thank you for contributing to our project and helping to build a welcoming, diverse, and inclusive community!