-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extra Filed Deleted, Made it easy to load
- Loading branch information
fineanmol
committed
Jul 29, 2024
1 parent
ffe7c93
commit e44c8ce
Showing
2 changed files
with
120 additions
and
101 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,67 +1,90 @@ | ||
| # Contribution Guidelines 📚 | ||
|
|
||
| # Contribution Rules📚: | ||
| Welcome to our project! We appreciate your interest and contributions. Please read the following guidelines carefully to ensure a smooth collaboration. | ||
|
|
||
| - You are allowed to make pull requests that break the rules. We just merge it ;) | ||
| - Do NOT add any build steps e.g npm install (we want to keep this a simple static site) | ||
| - Do NOT remove other content. | ||
| - Styling/code can be pretty, ugly or stupid, big or small as long as it works | ||
| - Add your name to the contributorsList file | ||
| - Try to keep pull requests small to minimize merge conflicts | ||
| ## General Rules: | ||
|
|
||
| - **Creativity Allowed:** Feel free to submit pull requests that break the rules—we might just merge them anyway! | ||
| - **No Build Steps:** Avoid adding build steps like `npm install` to maintain simplicity as a static site. | ||
| - **Preserve Existing Content:** Do not remove existing content. | ||
| - **Code Style:** Your code can be neat, messy, simple, or complex. As long as it works, it's welcome. | ||
| - **Add Your Name:** Remember to add your name to the `contributorsList` file. | ||
| - **Keep it Small:** Aim for small pull requests to minimize merge conflicts and streamline reviews. | ||
|
|
||
| ## Getting Started 🤩🤗: | ||
| ## Getting Started 🤩🤗 | ||
|
|
||
| - Fork this repo (button on top) | ||
| - Clone on your local machine | ||
| 1. **Fork the Repository:** | ||
| - Use the fork button at the top right of the repository page. | ||
|
|
||
| ```terminal | ||
| git clone https://github.com/fineanmol/Hacktoberfest2022.git | ||
| ``` | ||
| - Navigate to project directory. | ||
| ```terminal | ||
| cd Hacktoberfest2022 | ||
| ``` | ||
| 2. **Clone Your Fork:** | ||
| - Clone the forked repository to your local machine. | ||
|
|
||
| - Create a new Branch | ||
| ```bash | ||
| git clone https://github.com/fineanmol/Hacktoberfest2024.git | ||
| ``` | ||
|
|
||
| ```markdown | ||
| git checkout -b my-new-branch | ||
| ``` | ||
| - Add your Name to `contributors/contributorsList.js` | ||
| ```markdown | ||
| git add . | ||
| ``` | ||
| - Commit your changes. | ||
| 3. **Navigate to the Project Directory:** | ||
|
|
||
| ```markdown | ||
| git commit -m "Relevant message" | ||
| ``` | ||
| - Then push | ||
| ```markdown | ||
| git push origin my-new-branch | ||
| ``` | ||
| ```bash | ||
| cd Hacktoberfest2024 | ||
| ``` | ||
|
|
||
| 4. **Create a New Branch:** | ||
|
|
||
| - Create a new pull request from your forked repository | ||
| ```bash | ||
| git checkout -b my-new-branch | ||
| ``` | ||
|
|
||
| <br> | ||
| 5. **Make Your Changes:** | ||
| - Add your name to `contributors/contributorsList.js` and make any other contributions. | ||
|
|
||
| ## Avoid Conflicts {Syncing your fork} | ||
| ```bash | ||
| git add . | ||
| ``` | ||
|
|
||
| An easy way to avoid conflicts is to add an 'upstream' for your git repo, as other PR's may be merged while you're working on your branch/fork. | ||
| 6. **Commit Your Changes:** | ||
|
|
||
| ```terminal | ||
| git remote add upstream https://github.com/fineanmol/Hacktoberfest2022 | ||
| ``` | ||
| ```bash | ||
| git commit -m "Relevant message" | ||
| ``` | ||
|
|
||
| You can verify that the new remote has been added by typing | ||
| ```terminal | ||
| git remote -v | ||
| ``` | ||
| 7. **Push to Your Branch:** | ||
|
|
||
| ```bash | ||
| git push origin my-new-branch | ||
| ``` | ||
|
|
||
| 8. **Create a Pull Request:** | ||
| - Go to your forked repository on GitHub and create a pull request to the main repository. | ||
|
|
||
| ## Avoiding Conflicts {Syncing Your Fork} | ||
|
|
||
| To keep your fork up-to-date with the main repository and avoid conflicts: | ||
|
|
||
| 1. **Add Upstream Remote:** | ||
|
|
||
| ```bash | ||
| git remote add upstream https://github.com/fineanmol/Hacktoberfest2024 | ||
| ``` | ||
|
|
||
| 2. **Verify the New Remote:** | ||
|
|
||
| ```bash | ||
| git remote -v | ||
| ``` | ||
|
|
||
| 3. **Sync Your Fork with Upstream:** | ||
|
|
||
| ```bash | ||
| git fetch upstream | ||
| git merge upstream/master | ||
| ``` | ||
|
|
||
| This will pull in changes from the parent repository and help you resolve any conflicts. | ||
|
|
||
| 4. **Keep Updated:** | ||
| - Regularly pull changes from the upstream repository to keep your fork updated. | ||
|
|
||
| We look forward to your contributions and thank you for being a part of our community! | ||
|
|
||
| To pull any new changes from your parent repo simply run | ||
| ```terminal | ||
| git merge upstream/master | ||
| ``` | ||
|
|
||
| This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent. |
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