Code Monkey home page Code Monkey logo

joywin2003 / tech-docs Goto Github PK

View Code? Open in Web Editor NEW
29.0 1.0 34.0 110 KB

Explore and contribute to comprehensive technical guides on various topics like mobile phones, laptops, accessories, and automobiles. Your expertise can enhance our knowledge base! Contribute in specific folders and join us in celebrating Hacktoberfest! ๐ŸŽ‰

hacktoberfest hacktoberfest-accepted hacktoberfest-starter hacktoberfest2023 hacktoberfest2023-accepted no-code non-tech non-technical technical-documentation technical-documentation-page

tech-docs's Introduction

Welcome Contributors to the Technical Documentation Repository! ๐Ÿš€

To ensure a smooth and productive contribution process, please follow these guidelines:

  1. Contribution Structure: We're inviting you to contribute to our technical documentation on various topics. Please contribute in the respective folders:

    • Mobile Phones
    • Laptops
    • Accessories
    • Automobiles
    • (You are allowed to add more topics and content but it should be a valid one)
  2. Hacktoberfest Tag: When submitting your contribution, make sure to add the "hacktoberfest" tag to your Pull Request (PR). This helps us track and celebrate your participation in Hacktoberfest. ๐ŸŽ‰

  3. Contribution File: In the root of the repository, you'll find a CONTRIBUTORS.md file. Please add your name to this file in alphabetical order under the respective category. Your contributions are appreciated and recognized! ๐Ÿ‘

  4. The most Important step for the PR to be accepted: Please like the repo ๐ŸŒŸ๐Ÿ˜‰

How to Contribute

To contribute to our technical documentation:

  1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy in your GitHub account. ๐Ÿด

  2. Clone Your Fork: Clone the forked repository to your local machine using Git. ๐Ÿ–ฅ๏ธ

    git clone https://github.com/yourusername/Technical-documentation.git
    
  3. Create a Branch: Create a new branch for your contribution under the respective folder. ๐ŸŒฟ

    git checkout -b add-mobile-phones
    
  4. Make Changes: Add your technical documentation following the provided format. โœ๏ธ

Phone Model Name: [Enter Phone Model Name]

Specifications:

Processor: [Enter Processor Details]
RAM: [Enter RAM Size]
Storage: [Enter Storage Capacity]
Display: [Enter Display Size and Type]
Camera: [Enter Camera Specifications]
Battery: [Enter Battery Capacity]
Operating System: [Enter OS Version]
Connectivity: [Enter Connectivity Features]
Additional Features: [Enter any Special Features]
Why Choose [Phone Model Name]?
[Explain briefly why someone should choose this phone model. Highlight unique features, performance, or any other selling points.]

Note: This is a generic template. Please replace the placeholders with actual specifications and details for the specific phone model you are documenting.
  1. Add and Commit Your Changes: Commit your changes with a descriptive commit message. ๐Ÿ’ฌ

    git add file_name
    git commit -m "Add 'Mobile Phones' documentation"
    
  2. Push to Your Fork: Push your changes to your GitHub fork. ๐Ÿš€

    git push origin add-mobile-phones
    
  3. Open a Pull Request: Submit a Pull Request (PR) to the main repository under the respective category. Include a clear title and description of your changes. ๐ŸŽฏ

  4. Review and Merge: We will review your PR, and if it meets our guidelines, it will be merged into the documentation. ๐Ÿค

Code of Conduct

Please review and adhere to our Code of Conduct when participating in this project. Respect, inclusivity, and positive interactions are essential to our community. ๐Ÿค

Like the Repository! โญ๏ธ

As a first step, please consider giving our repository a โญ๏ธ to show your support! ๐ŸŒŸ

Happy contributing and all the best for hacktoberfest! ๐Ÿ’ป๐Ÿ“š๐Ÿš—

tech-docs's People

Contributors

abhi-abhinav avatar adwxith avatar anishshobithps avatar ashel111 avatar cchaithanya83 avatar cianar99 avatar githubjerin avatar hayagreevan-v avatar jenishpraveenkumarg avatar joywin2003 avatar maddlymadhan avatar op-amateur avatar pranavvraja avatar prathamvbhat avatar ranvillecarlo avatar sar-taj107 avatar shalton2005 avatar sharontm avatar sharukphoenix avatar shawnmont772004 avatar shenoyash avatar siva-pythonpirates avatar subhikshaa23 avatar sumanjeet0012 avatar thedrinkingmaster avatar thejasbshetty avatar toyyib10 avatar uthpalsuvarna avatar varun2026 avatar yashrajmani avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.