Skip to content

Latest commit

 

History

History
134 lines (97 loc) · 4.9 KB

Learn.md

File metadata and controls

134 lines (97 loc) · 4.9 KB
Raw

Learn.md

Table of Contents

  1. Introduction
  2. Contributing
  3. Setting Up on your machine
  4. Resources for Beginners
  5. Documentation
  6. Code Reviews
  7. Feature Requests
  8. Spreading the Word

Introduction 🖥️

Clippy is an online clipboard tool, to solve the age-old problem of coping and pasting a breeze, it also comes with features like file sharing. Clippy is made with Nextjs and uses MongoDB for storage.

Contributing 📝

Raise and issue; Get assigned and then work on fixing the issue. We welcome contributions to clippy! Follow these steps to contribute:

  1. Fork the Repository: Create your own copy of the repository on your GitHub account. image

  2. Clone the Repository : Clone the repository for making commits.

    git clone https://github.com/subinoybiswas/clippy.git

image

  1. Create a New Branch for your feature or bug fix: Make a separate branch to work on specific features or fixes and switch to the correct branch.
git checkout -b <new-branch-name>
  1. Make Changes and commit them: Implement your changes and save them with a descriptive commit message.
git add .
git commit -m "Describe your changes"
  1. Push Your Changes to your fork: Upload your committed changes to your GitHub fork. 
    git push origin <branch_name>
  2. Create a Pull Request ✅: Propose your changes to be merged into the original repository.

image

Development Workflow

  • Always work on a new branch for each issue or feature.
  • Keep your branch up to date with the main repository's master branch.
  • Write clear and descriptive commit messages.
  • Test your changes thoroughly before submitting a pull request.

Issue Report Process

  1. Go to the project's issues section.
  2. Select the appropriate template for your issue.
  3. Provide a detailed description of the issue.
  4. Wait for the issue to be assigned before starting to work on it.

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code.
  2. Make sure you have added the proper description for the functionality of the code.
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.

Setting Up on your machine ⚙️

Install Dependencies:

Navigate into the project directory and install the dependencies using your preferred package manager. For example, if you're using npm:

npm install

Set Up Environment Variables:

This project requires environment variables for MongoDB connection. Create a .env file in the root directory of the project and add the following variables:

MONGODB_URI=<your_mongodb_uri>
MONGO_DB_NAME=<your_db_name>
MONGO_COLLECTION_NAME=<your_collection_name>

Run the Development Server:

Once you have installed the dependencies and set up the environment variables, you can start the development server by running:

npm run dev

Resources for Beginners 📚

Basics of Git and GitHub 📂

📍Documentation

  • Document any significant changes or additions to the codebase.
  • Provide clear explanations of the functionality, usage, and any relevant considerations.

Code Reviews 🔎

  • Be open to feedback and constructive criticism from other contributors.
  • Participate in code reviews by reviewing and providing feedback.

Feature Requests 🔥

  • Suggest new features or improvements that would enhance the project.

Spreading the Word 👐

  • Share your experience and the project with others.
  • Spread the word about the project on social media, developer forums, or any relevant community platforms.

Thank you for contributing to clippy! Together, we can make a significant impact. Happy coding! 🚀 Don't forget to ⭐ the repository!