To ensure a smooth and productive contribution process, please follow these guidelines:
-
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)
-
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. 🎉
-
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! 👏 -
The most Important step for the PR to be accepted: Please like the repo 🌟😉
To contribute to our technical documentation:
-
Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy in your GitHub account. 🍴
-
Clone Your Fork: Clone the forked repository to your local machine using Git. 🖥️
git clone https://github.com/yourusername/Technical-documentation.git
-
Create a Branch: Create a new branch for your contribution under the respective folder. 🌿
git checkout -b add-mobile-phones
-
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.
-
Add and Commit Your Changes: Commit your changes with a descriptive commit message. 💬
git add file_name
git commit -m "Add 'Mobile Phones' documentation"
-
Push to Your Fork: Push your changes to your GitHub fork. 🚀
git push origin add-mobile-phones
-
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. 🎯
-
Review and Merge: We will review your PR, and if it meets our guidelines, it will be merged into the documentation. 🤝
Please review and adhere to our Code of Conduct when participating in this project. Respect, inclusivity, and positive interactions are essential to our community. 🤝
As a first step, please consider giving our repository a ⭐️ to show your support! 🌟
Happy contributing and all the best for hacktoberfest! 💻📚🚗