From da00416d7fcd344506d13e7bcbcb1e77ea5d5f22 Mon Sep 17 00:00:00 2001 From: theLazyProgrammer <48143641+nanafox@users.noreply.github.com> Date: Sun, 4 Feb 2024 19:21:17 +0000 Subject: [PATCH 1/2] Fixed the link to the CONTRIBUTING.md file While here, I refactored a few lines to make them markdown-compliant. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e462115..0d43527 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -## Algorithmia SE 🌎 +# Algorithmia SE 🌎 + Coming soon... -### Want To Contribute? -Read the CONTRIBUTING.md file +## Want To Contribute? + +Read the [CONTRIBUTING.md](CONTRIBUTING.md) file From 53f8fb21d1000d8c8b9e77a82f6445dd66f3c6aa Mon Sep 17 00:00:00 2001 From: theLazyProgrammer <48143641+nanafox@users.noreply.github.com> Date: Sun, 4 Feb 2024 19:22:19 +0000 Subject: [PATCH 2/2] Fixed markdown linting issues and document links The updates to this documentation file is more of standardizing on the markdown style of adding links. Also, general linting issues were resolved. As a result, all anchor tags have been changed to the makdown style instead. --- CONTRIBUTING.md | 87 ++++++++++++++++++++++++++++--------------------- 1 file changed, 50 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6ef5a5..78ce55b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,63 +1,74 @@ -## Collaborating On The Static Website -Collaborating on the static website, following the exact way it worked on the Demo Project. Collaboration can be done using the "fork and branch" workflow, using the following steps: +# Collaborating On The Static Website -1. Start by navigating to the GitHub Repo. +Collaborating on the static website, following the exact way it worked on the [Demo Project](https://github.com/ALX-SE-Algorithmia/Demo-Project>). Collaboration can be done using the "fork and branch" workflow, using the following steps: -2. Check out the "Issues" tab. Click the link below: - - ALX-SE-Algorithmia.github.io/issues +1. Start by navigating to the [GitHub Repo](https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/). + +2. Check out the **["Issues"](https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/issues)** tab. 3. For the Issues, you must have been assigned to work on an issue, with your teammates. If you haven't but would like to, simply comment under the preferred issue. 4. Start working on your issue with your team as soon as possible, and within the timeline for the deadline. You can follow the steps below to do so: -5. **Fork the forked repository for your team:** As the team lead or an external collaborator, you will need to fork the main repository. You can do this by navigating to the GitHub Repo, and click on the "Fork" button. This creates a copy of the repository under your GitHub account. Use the link below: - - Fork this repository: Click here +5. **Fork the forked repository for your team:** As the team lead or an external collaborator, you will need to fork the main repository. You can do this by navigating to the [GitHub Repo](https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/), and click on the "Fork" button. This creates a copy of the repository under your GitHub account. Use the link below: + - Fork this [repository](https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/fork) 6. **Send out collaboration invitations:** After forking the repo, send out GitHub Collaboration invitations to the people you were assigned to work with, on the assigned GitHub issue. 7. **Clone the Forked Repository:** Once you have forked the repository, clone it to your local machine using the `git clone` command. This creates a local copy of the repository that you can work with. - ``` + + ```bash git clone ``` 8. **Add the Original Repository as a Remote:** To keep your forked repository in sync with the original repository, you need to add the original repository as a remote. Navigate to the cloned repository on your local machine using the `cd` command, and then add the remote using the `git remote` command: - ``` + + ```bash cd git remote add upstream https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io ``` 9. **Create a New Branch:** Before making any changes, create a new branch in your local repository. This helps keep your changes isolated and organized. Use the `git branch` command followed by the branch name to create a new branch: - ``` + + ```bash git branch ``` + Kindly note that ` - ``` -11. **Make Changes and Commit:** Make the necessary changes to the codebase in your local repository. Once you have made the desired changes, stage the changes using `git add` and commit them using `git commit`: - ``` - git add fileName - git commit -m "Descriptive commit message" - ``` -**Please ensure that your commit messages are very professional and are also descriptive, as we have learned in the ALX SE program. This is of high importance, so as to aid smooth and steady collaboration.** + ```bash + git checkout + ``` -12. **Push Changes to Your Fork:** Once you're done collaborating on the solution as a team, push the changes from your local branch to the branch of the forked repository on the remote server: - ``` - git push origin - ``` +11. **Make Changes and Commit:** Make the necessary changes to the codebase in your local repository. + Once you have made the desired changes, stage the changes using `git add` and commit them using `git commit`: + + ```bash + git add filename ... + git commit -m "Descriptive commit message" + ``` + + **Please ensure that your commit messages are very professional and are also descriptive, as we have learned in the ALX SE program. This is of high importance, so as to aid smooth and steady collaboration.** + +12. **Push Changes to Your Fork:** Once you're done collaborating on the solution as a team, push the + changes from your local branch to the branch of the forked repository on the remote server: -13. **Create a Pull Request:** Go to your forked repository on the hosting platform (e.g., GitHub), switch to the branch you just pushed, and click on the "New Pull Request" button. This will allow you to submit your changes to the original repository for review. -**When making pull requests, it is also important that your messages and descriptions are straightforward, and contain a description of your contribution, as in the Demo Project. This is extra-important. -Tag the Code Review team, to notify them that you are finished with the issue you have been assigned to fix.**
-You tag the Code Review Team by typing: `@ALX-SE-Algorithmia/code-reviewing-team` + ```bash + git push origin + ``` + +13. **Create a Pull Request:** Go to your forked repository on the hosting platform (e.g., GitHub), + switch to the branch you just pushed, and click on the "New Pull Request" button. This will allow you to submit your changes to the original repository for review. + **When making pull requests, it is also important that your messages and descriptions are straightforward, and contain a description of your contribution, as in the [Demo Project](https://github.com/ALX-SE-Algorithmia/Demo-Project/). This is extra-important. + Tag the Code Review team, to notify them that you are finished with the issue you have been assigned to fix.**
You tag the Code Review Team by typing: `@ALX-SE-Algorithmia/code-reviewing-team` 14. Wait for your pull request to be merged. 15. Once your PR has been merged, you need to sync your forked repository with the changes made in the original repository. To do this, fetch the changes from the original repository using the remote you added earlier and then merge those changes into your local branch: - ``` + + ```bash git fetch upstream git merge upstream/main # or upstream/master for older conventions ``` @@ -66,19 +77,21 @@ You tag the Code Review Team by typing: `@ALX-SE-Algorithmia/code-reviewing-team By following these steps, you can effectively collaborate on our Static GitHub Website. +## Need More Clarifications? + +- Here's a ***[YouTube Video](https://youtu.be/Qeibe59f72s).*** Hope it helps! + +## Useful Links +- [Static Website Collaboration](https://docs.google.com/document/d/1xyfMAVnIS_wzdov7WCAJqiysbiDK9EemSrmUql16BF4/edit) -#### Need More Clarifications? -- Here's a YouTube Video. Hope it helps! +- [Home Page (Figma Prototype)]() +- [Events Page (Figma Prototype)](https://www.figma.com/proto/dZE0hWhNqcgolmITw5KUKV/Algorithmia-SE-Website?type=design&node-id=68-50&t=O8rGPIFi2zdg1u11-1&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=541%3A379&mode=design) +- [Projects Page (Figma Prototype)](https://www.figma.com/proto/dZE0hWhNqcgolmITw5KUKV/Algorithmia-SE-Website?type=design&node-id=26-51&t=lrwFyeZhwBIg7MNw-1&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=541%3A379&mode=design>") +-[Blogs Page (Figma Prototype)](https://www.figma.com/proto/dZE0hWhNqcgolmITw5KUKV/Algorithmia-SE-Website?type=design&node-id=217-149&t=QYinztsDNlaHi6Xl-1&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=541%3A379&mode=design>) -#### Useful Links" -+ Static Website Collaboration -+ Home Page (Figma Prototype) -+ Events Page (Figma Prototype) -+ Projects Page (Figma Prototype) -+ Blogs Page (Figma Prototype) +- [Google Doc (Website Details)](https://docs.google.com/document/d/1GWltuULw7BjHkrT66N243f6Uak5guNJD_N154PZtqvA/edit?usp=sharing) -+ Google Doc (Website Details)