Skip to content

Commit

Permalink
Update CONTRIBUTION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dohoudaniel authored Oct 3, 2023
1 parent 390ed0c commit 74d6386
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Collaborating on the static website, following the exact way it worked on the <a
2. Check out the "Issues" tab. Click the link below:
- <a href="https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/issues">ALX-SE-Algorithmia.github.io/issues</a>

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.
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. Wait for the response from the Code Review Team. After that, that issue will be assigned to you, and with a specific deadline too.
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. 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:

6. **Fork the repository:** Start by navigating back to the <a href="https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/">GitHub Repo</a>, and click on the "Fork" button. This creates a copy of the repository under your GitHub account. Use the link below:
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 <a href="https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/">GitHub Repo</a>, and click on the "Fork" button. This creates a copy of the repository under your GitHub account. Use the link below:
- Fork this repository: <a href="https://github.com/ALX-SE-Algorithmia/ALX-SE-Algorithmia.github.io/fork">Click here</a>

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.
```
git clone <your-forked-repo-url>
Expand All @@ -30,7 +30,7 @@ Collaborating on the static website, following the exact way it worked on the <a
```
git branch <branch-name>
```
Kindly note that `<branch-name` should be your GitHub username.
Kindly note that `<branch-name` should be your GitHub username. E.g: `algorithmiase`

10. **Switch to the New Branch:** Switch to the newly created branch using the `git checkout` command:
```
Expand All @@ -39,19 +39,20 @@ Collaborating on the static website, following the exact way it worked on the <a

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 .
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:** Push the changes from your local branch to your forked repository on the remote server:
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 <branch-name>
```

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 <a href="https://github.com/ALX-SE-Algorithmia/Demo-Project/">Demo Project</a>. 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.**
Tag the Code Review team, to notify them that you are finished with the issue you have been assigned to fix.** <br>
You tag the Code Review Team by typing: `@ALX-SE-Algorithmia/code-reviewing-team`

14. Wait for your pull request to be merged.

Expand All @@ -68,12 +69,15 @@ By following these steps, you can effectively collaborate on our Static GitHub W


#### Need More Clarifications?
Click the link below to watch a video on how collaboration on this project can be done:
- <strong><em><a href="https://youtu.be/Qeibe59f72s">YouTube Video</a></em></strong>
- Here's a <strong><em><a href="https://youtu.be/Qeibe59f72s">YouTube Video</a></em></strong>. Hope it helps!

#### Useful Links"
+ <a href="https://www.figma.com/proto/dZE0hWhNqcgolmITw5KUKV/Algorithmia-SE-Website?type=design&node-id=541-379&t=mSpiguRB4NRl4hQ1-0&scaling=scale-down-width&page-id=0%3A1&starting-point-node-id=34%3A488">Figma Presentation (Home Page)</a>
+ <a href="https://docs.google.com/document/d/1GWltuULw7BjHkrT66N243f6Uak5guNJD_N154PZtqvA/edit?usp=sharing">Website Details</a>
+ <a href="https://www.figma.com/proto/dZE0hWhNqcgolmITw5KUKV/Algorithmia-SE-Website?type=design&node-id=541-379&t=mSpiguRB4NRl4hQ1-0&scaling=scale-down-width&page-id=0%3A1&starting-point-node-id=34%3A488">Home Page (Figma Prototype)</a>
+ <a href="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">Events Page (Figma Prototype)</a>
+ <a href="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">Blogs Page (Figma Prototype)</a>
<!-- + <a href="">About Us Page (Figma Prototype)</a>
+ <a href="">Projects Page (Figma Prototype)</a> -->
+ <a href="https://docs.google.com/document/d/1GWltuULw7BjHkrT66N243f6Uak5guNJD_N154PZtqvA/edit?usp=sharing">Google Doc (Website Details)</a>
<!-- + <a href="https://docs.google.com/document/d/1cYYwSZkB4SAw22hN7YMHBtFbSnkbRRjBYHuB1v4SE6o/edit?usp=sharing">Home Page</a> -->
<!--
https://drive.google.com/file/d/1fHZAPNNHwp8ia0u0RhnJGwV8DOATmxeh/view?usp=drive_link
Expand Down

0 comments on commit 74d6386

Please sign in to comment.