Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 2.5 KB
Raw

Contributing to the Coding Meme Project

Thank you for your interest in contributing to the Coding Meme Project! Whether you're here to suggest a new feature, report a bug, or offer your help in other ways, we appreciate your effort. The following guidelines will help ensure a smooth contribution process.

Table of Contents

  1. Setting Up Your Environment
  2. How to Contribute
  3. Pull Request Guidelines
  4. Code of Conduct
  5. Seeking Help

Setting Up Your Environment

Before you can contribute, please make sure you have the following:

  • A GitHub account.
  • Git installed on your machine.
  • Fork the repository to your account and clone it to your local machine.

How to Contribute

  1. Fork & Clone: If you haven’t already, fork the project, then clone your fork locally.

  2. Branch: Create a new branch based on the main branch. Use a branch name that briefly tells what your contribution is about, e.g., add-new-meme or fix-typo-in-readme.

  3. Add Meme/Joke:

    • For memes: Save your meme image in the src/memes/ folder. Accepted file formats are .png, .jpg, and .svg.
    • For jokes: Write your joke in a new JavaScript file inside the src/jokes/ folder. Export your joke as a string.

  4. Commit: Commit your changes. Use a clear and meaningful commit message.

  5. Push: Push your changes to your GitHub repository.

  6. Pull Request: Go to your fork on GitHub and create a new pull request against the main branch of the original repository.

Pull Request Guidelines

  • PRs should be small and concise. Avoid bundling multiple changes in a single PR.
  • Update the PR template with all the required details.
  • Ensure that your PR doesn’t have any merge conflicts.
  • If your PR addresses a specific issue, reference that issue in the PR description.
  • Make sure your contributions don't violate the project's Code of Conduct.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it before you start participating.

Seeking Help

If you run into any issues or need guidance on a contribution, please don't hesitate to ask. You can reach out by [opening an issue](https://github.com/YOUR_USERNAME/memes-collection /issues) on GitHub.

Thank you for your contributions and being a part of our community!