-
Notifications
You must be signed in to change notification settings - Fork 108
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #65 from say-het/update
Added Detailed CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
90 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| ### **`CONTRIBUTING.md`** | ||
| # Contributing to Stark Tech Portfolio | ||
|
|
||
| Thank you for considering contributing to the **Stark Tech Portfolio** project, a tribute to Iron Man! Your contributions help improve the project, whether through bug fixes, feature additions, or documentation updates. To ensure smooth collaboration, please follow the guidelines below. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| ### 1. Fork the Repository | ||
| To get started, first fork the repository to your GitHub account. This allows you to make changes without affecting the original project. | ||
|
|
||
| - Navigate to the repository's main page: [Stark Tech Portfolio](https://github.com/aslams2020/Stark-Tech-Portfolio). | ||
| - Click the **"Fork"** button in the upper right corner. | ||
| - You will now have a copy of the repository under your GitHub account. | ||
|
|
||
| ### 2. Clone and Create a Branch | ||
| Once you've forked the repository, clone your copy locally and create a new branch to work on: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/YourUsername/Stark-Tech-Portfolio.git | ||
| cd Stark-Tech-Portfolio | ||
| git checkout -b feature/your-feature-name | ||
| ``` | ||
|
|
||
| ### 3. Request Assignment for an Issue | ||
| Before starting any work, check the **Issues** section to find existing issues or create a new one to describe your planned contribution. | ||
|
|
||
| - If you find an issue you'd like to work on, comment to request assignment under **GSSoC-Extd 2024**. | ||
| - If no issue exists, create a new one outlining the feature or bug and request assignment. | ||
|
|
||
| > **Note:** Wait for a maintainer to assign you to an issue before proceeding. | ||
| ### 4. Make Your Changes | ||
| After being assigned to an issue, you can start working on your contribution. Follow these principles: | ||
|
|
||
| - **High-Tech Design**: Ensure that the design and code align with the project's sleek, modern, and high-tech aesthetic. | ||
| - **Code Quality**: Write clean, modular, and well-commented code. | ||
| - **JavaScript Features**: If you’re adding interactive elements, ensure they reflect the innovative nature of Stark Industries. | ||
|
|
||
| ### 5. Test Your Changes | ||
| Before submitting your contribution, thoroughly test your changes to ensure they work as expected: | ||
|
|
||
| - Test the website layout and functionality on various devices and screen sizes. | ||
| - Ensure any new JavaScript features work properly and don’t break existing functionality. | ||
| - Validate HTML, CSS, and JavaScript code. | ||
|
|
||
| ### 6. Commit Your Changes | ||
| After testing, stage and commit your changes: | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit -m "Add feature: Brief description of the feature or fix" | ||
| ``` | ||
|
|
||
| ### 7. Push Your Branch to GitHub | ||
| Push your branch to your GitHub repository: | ||
|
|
||
| ```bash | ||
| git push origin feature/your-feature-name | ||
| ``` | ||
|
|
||
| ### 8. Submit a Pull Request (PR) | ||
| Once your branch is pushed, open a Pull Request (PR) to the original repository: | ||
|
|
||
| - Go to your forked repository on GitHub. | ||
| - Click the **"Compare & pull request"** button. | ||
| - Provide a clear description of your changes in the PR description. | ||
| - Submit the PR for review. | ||
|
|
||
| ### 9. Wait for Review | ||
| After submitting your pull request, a maintainer will review your code. Be prepared for feedback and necessary revisions. | ||
|
|
||
| ## Contribution Guidelines | ||
|
|
||
| - **New Features**: Ensure new features are well-documented and add to the overall functionality of the project. | ||
| - **Code Quality**: Keep code modular, and adhere to project coding standards. | ||
| - **Commit Messages**: Use clear and concise commit messages. | ||
| - **Documentation**: Update relevant documentation for new features or significant changes. | ||
| - **Testing**: Ensure changes are thoroughly tested, especially responsive design elements. | ||
|
|
||
| ## Code of Conduct | ||
| We follow the [Code of Conduct](https://github.com/aslams2020/Stark-Tech-Portfolio/blob/main/CODE_OF_CONDUCT.md). All contributors are expected to adhere to these guidelines to maintain a respectful and collaborative environment. | ||
|
|
||
| ## Thank You for Contributing! | ||
| Your time and effort in contributing to the Stark Tech Portfolio project are highly appreciated. Let’s keep improving this portfolio and making it a true tribute to the innovation of Stark Industries! | ||
|
|
||
| ### Key Points: | ||
| - Request assignment before starting any work. | ||
| - Follow the project’s style and coding guidelines. | ||
| - Test your contributions across various devices. | ||
|
|