-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Done some enhancements in the document and also added some new sections
- Loading branch information
1 parent
d47d59c
commit 20b514e
Showing
1 changed file
with
184 additions
and
33 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 |
|---|---|---|
| @@ -1,58 +1,209 @@ | ||
| # Contributing to [GitFinder](https://github.com/BamaCharanChhandogi/GitFinder) | ||
| # Contributing to [GitFinder](https://github.com/BamaCharanChhandogi/GitFinder) 🎯 | ||
|
|
||
| Thank you for considering contributing to GitHub Finder! We appreciate your interest in helping us improve our platform for the developer community. Here are some guidelines to help you get started. | ||
|
|
||
| ## How to Contribute | ||
| <br> | ||
|
|
||
| ### 1. Fork the Repository | ||
| - Click the **Fork** button at the top right of the repository page to create your copy of the repository. | ||
| # Code of Conduct | ||
|
|
||
| ### 2. Clone Your Fork | ||
| - Clone your forked repository to your local machine using: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/your-username/gitfinder.git | ||
| By participating in this project, you agree to abide by our [CODE OF CONDUCT](https://github.com/BamaCharanChhandogi/GitFinder/blob/main/Code_Of_Conduct.md.) | ||
|
|
||
| <br> | ||
|
|
||
| # Need Help with the Basics? 🤔 | ||
|
|
||
| If you're new to Git and GitHub, no worries! Here are some useful resources: | ||
|
|
||
| - [Forking a Repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) | ||
| - [Cloning a Repository](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) | ||
| - [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) | ||
| - [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) | ||
| - [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources) | ||
|
|
||
| <br> | ||
|
|
||
| # Project Structure 📂 | ||
|
|
||
| ```bash | ||
| GITFINDER/ | ||
| ├── .github/ # GitHub-related configurations and workflows | ||
| │ | ||
| ├── public/ # Public assets like HTML, images, or static files for the project | ||
| │ | ||
| ├── src/ # Source code files (likely JavaScript/TypeScript/React) | ||
| │ | ||
| ├── .env.example # Example environment variables configuration | ||
| ├── .gitignore # Git ignore file to exclude specific files/folders from version control | ||
| ├── Code_Of_Conduct.md # Code of Conduct for contributors | ||
| ├── CONTRIBUTING.md # Contribution guidelines for the project | ||
| ├── LICENSE # License file for the project | ||
| ├── package-lock.json # Auto-generated file for locking versions of dependencies | ||
| ├── package.json # Project metadata and dependencies | ||
| ├── README.md # Overview, setup instructions, and details about the project | ||
| ├── tailwind.config.js # Configuration file for Tailwind CSS | ||
| ``` | ||
| * Replace your-username with your GitHub username. | ||
|
|
||
| ### Create a Branch | ||
| <br> | ||
|
|
||
| # First Pull Request ✨ | ||
|
|
||
| * Create a new branch for your feature or bug fix: | ||
| 1. **Star this repository** | ||
| Click on the top right corner marked as **Stars** at last. | ||
|
|
||
| ```bash | ||
| git checkout -b feature-name | ||
| ``` | ||
| 2. **Fork this repository** | ||
| Click on the top right corner marked as **Fork** at second last. | ||
|
|
||
| ### Make Changes | ||
| 3. **Clone the forked repository** | ||
|
|
||
| * Make your changes in your local repository. Be sure to follow our coding style and best practices. | ||
| ```bash | ||
| git clone https://github.com/<your-github-username>/GitFinder.git | ||
| ``` | ||
|
|
||
| 4. **Navigate to the project directory** | ||
|
|
||
| ### Commit Your Changes | ||
| ```bash | ||
| cd GitFinder | ||
| ``` | ||
|
|
||
| * Commit your changes with a clear and concise commit message: | ||
| 5. **Create a new branch** | ||
|
|
||
| ```bash | ||
| git commit -m "Add a brief description of your changes" | ||
| git checkout -b <your_branch_name> | ||
| ``` | ||
|
|
||
| ### Push to Your Fork | ||
| * Push your changes back to your forked repository: | ||
| 6. **To make changes** | ||
|
|
||
| ```bash | ||
| git push origin feature-name | ||
| git add . | ||
| ``` | ||
| ### Create a Pull Request | ||
|
|
||
| * Go to the original repository where you want to contribute. | ||
| * Click on the Pull Requests tab and then click on New Pull Request. | ||
| * Select your branch and provide a clear description of your changes. Be sure to reference any issues your pull request addresses. | ||
| 7. **Now to commit** | ||
|
|
||
| Code of Conduct | ||
| By participating in this project, you agree to abide by our [CODE OF CONDUCT](https://github.com/BamaCharanChhandogi/GitFinder/blob/main/Code_Of_Conduct.md.) | ||
| ```bash | ||
| git commit -m "add comment according to your changes or addition of features inside this" | ||
| ``` | ||
|
|
||
| 8. **Push your local commits to the remote repository** | ||
|
|
||
| ```bash | ||
| git push -u origin <your_branch_name> | ||
| ``` | ||
|
|
||
| 9. **Create a Pull Request** | ||
|
|
||
| 10. **Congratulations! 🎉 you've made your contribution** | ||
|
|
||
| <br> | ||
|
|
||
| # Alternatively, contribute using GitHub Desktop 🖥️ | ||
|
|
||
| 1. **Open GitHub Desktop:** | ||
| Launch GitHub Desktop and log in to your GitHub account if you haven't already. | ||
|
|
||
| 2. **Clone the Repository:** | ||
| - If you haven't cloned the Project-Guidance repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository." | ||
| - Choose the Project-Guidance repository from the list of repositories on GitHub and clone it to your local machine. | ||
|
|
||
| 3.**Switch to the Correct Branch:** | ||
| - Ensure you are on the branch that you want to submit a pull request for. | ||
| - If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch. | ||
|
|
||
| 4. **Make Changes:** | ||
| - Make your changes to the code or files in the repository using your preferred code editor. | ||
|
|
||
| 5. **Commit Changes:** | ||
| - In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit. | ||
| - Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to <branch-name>" button to commit your changes to the local branch. | ||
|
|
||
| 6. **Push Changes to GitHub:** | ||
| - After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub. | ||
|
|
||
| 7. **Create a Pull Request:** | ||
| - Go to the GitHub website and navigate to your fork of the Project-Guidance repository. | ||
| - You should see a button to "Compare & pull request" between your fork and the original repository. Click on it. | ||
|
|
||
| 8. **Review and Submit:** | ||
| - On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request. | ||
| - Once you're satisfied, click the "Create pull request" button to submit your pull request. | ||
|
|
||
| 9. **Wait for Review:** | ||
| Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the Project-Guidance repository. | ||
|
|
||
| <br> | ||
|
|
||
| # For Help And Support 💬 | ||
|
|
||
| - Admin :- Bama Charan Chhandogi | ||
| - Contact :- [Email]([email protected]) | ||
|
|
||
| <br> | ||
|
|
||
| # Good Coding Practices 🧑💻 | ||
|
|
||
| 1. **Follow the Project's Code Style** | ||
|
|
||
| - Maintain consistency with the existing code style (indentation, spacing, comments). | ||
| - Use meaningful and descriptive names for variables, functions, and classes. | ||
| - Keep functions short and focused on a single task. | ||
| - Avoid hardcoding values; instead, use constants or configuration files when possible. | ||
|
|
||
| 2. **Write Clear and Concise Comments** | ||
|
|
||
| - Use comments to explain why you did something, not just what you did. | ||
| - Avoid unnecessary comments that state the obvious. | ||
| - Document complex logic and functions with brief explanations to help others understand your thought -process. | ||
|
|
||
| 3. **Keep Code DRY (Don't Repeat Yourself)** | ||
|
|
||
| - Avoid duplicating code. Reuse functions, methods, and components whenever possible. | ||
| - If you find yourself copying and pasting code, consider creating a new function or component. | ||
|
|
||
| 4. **Write Tests** | ||
|
|
||
| - Write unit tests for your functions and components. | ||
| - Ensure your tests cover both expected outcomes and edge cases. | ||
| - Run tests locally before making a pull request to make sure your changes don’t introduce new bugs. | ||
|
|
||
| 5. **Code Reviews and Feedback** | ||
|
|
||
| - Be open to receiving constructive feedback from other contributors. | ||
| - Conduct code reviews for others and provide meaningful suggestions to improve the code. | ||
| - Always refactor your code based on feedback to meet the project's standards. | ||
|
|
||
| <br> | ||
|
|
||
| # Pull Request Process 🚀 | ||
|
|
||
| When submitting a pull request, please adhere to the following: | ||
|
|
||
| 1. **Self-review your code** before submission. 😀 | ||
| 2. Include a detailed description of the functionality you’ve added or modified. | ||
| 3. Comment your code, especially in complex sections, to aid understanding. | ||
| 4. Add relevant screenshots to assist in the review process. | ||
| 5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀 | ||
|
|
||
| <br> | ||
|
|
||
| # Issue Report Process 📌 | ||
|
|
||
| To report an issue, follow these steps: | ||
|
|
||
| 1. Navigate to the project's issues section :- [Issues](https://github.com/BamaCharanChhandogi/GitFinder/issues) | ||
| 2. Provide a clear and concise description of the issue. | ||
| 3. Wait until someone looks into your report. | ||
| 4. Begin working on the issue only after you have been assigned to it. 🚀 | ||
|
|
||
| <br> | ||
|
|
||
| # Additional Notes 📜 | ||
|
|
||
| Please ensure your code is well-documented and includes appropriate tests where applicable. | ||
| For larger changes, consider opening an issue to discuss your ideas before implementing them. | ||
|
|
||
| <br> | ||
|
|
||
| ### Additional Notes | ||
| # Thank you for contributing 💗 | ||
|
|
||
| * Please ensure your code is well-documented and includes appropriate tests where applicable. | ||
| * For larger changes, consider opening an issue to discuss your ideas before implementing them. | ||
| We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀 | ||
|
|
||
| # Thank you for your contributions! Together, we can make GitHub Finder a great platform for developers. | ||
| ## |