Skip to content
This repository was archived by the owner on Sep 11, 2024. It is now read-only.

Commit fc0896e

Browse files
Added CONTRIBUTING.md and Newcomers.md (#41)
* Create CONTRIBUTING.md * Create NEWCOMERS.md * Added contributing.md and newcomers.md * Added contributing.md and newcomers.md * Update CONTRIBUTING.md Added missing link Co-authored-by: Eddie Jaoude <eddie@jaoudestudios.com> * Added missing links and corrected typo Co-authored-by: Eddie Jaoude <eddie@jaoudestudios.com>
1 parent 7da0941 commit fc0896e

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# CONTRIBUTING GUIDELINES
2+
:tada: Welcome to Eddie Jaoude community, thank you for your interest in contributing to our projects. :balloon: To get started, please read the [Code of Conduct](https://github.com/EddieJaoudeCommunity/EddieJaoudeCommunity.github.io/blob/develop/CODE_OF_CONDUCT.md)
3+
4+
# EDDIE JAOUDE COMMUNITY PROJECTS
5+
Our projects are open to all contributors, to get started with contributing to our projects, you can check out our projects [here](https://github.com/EddieJaoudeCommunity), and choose a project you wish to make contributions to.
6+
7+
# HOW DO I CONTRIBUTE TO A PROJECT?
8+
- If this is your first contribution, see [NEWCOMERS.md](NEWCOMERS.md). You might also want to take up issues with the [good first issue](https://github.com/EddieJaoudeCommunity/EddieJaoudeCommunity.github.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [help wanted](https://github.com/EddieJaoudeCommunity/EddieJaoudeCommunity.github.io/labels/help%20wanted) label.
9+
10+
- Discuss the changes you wish to make by creating an [issue](https://github.com/EddieJaoudeCommunity/EddieJaoudeCommunity.github.io/issues/new) or comment on an already created issue, or contact us via our [discord channel](https://discord.com/invite/jZQs6Wu).
11+
- Once, you have been assigned the issue by the maintainer, you can go ahead to fork the repo, clone and make changes to fix the issue. For steps on how to do this, this [here](NEWCOMERS.md) is a helpful guide.
12+
13+
# MAKING YOUR PULL REQUEST
14+
When you are done with your changes, and you have checked the new changes you made, you can now create a pull request referencing the number of the issue you fixed in the description as seen here:
15+
```
16+
This PR fixes issue # "issue number"
17+
```
18+
19+
Once, you have completed this, your pull request would be reviewed by a maintainer, if it satisfies the requirements of the corresponding issue to which it was made, it would be merged.
20+
21+
Kudos to you :ballons:
22+
23+
24+
25+
26+
Feel free to reach out to us on our [discord channel](https://discord.com/invite/jZQs6Wu).
27+
THANK YOU FOR CONTRIBUTING TO EDDIE JAOUDE COMMUNITY.

NEWCOMERS.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# GIT CONTRIBUTION FLOW
2+
To make changes to a repository, follow these steps;
3+
4+
# Fork The Repository
5+
- On the top right, click on the fork button, a copy of the repository would be created on your github account, this would take few seconds to get completed.
6+
- Once this is done, click on the green clone drop-down by the top left and copy the url you see, you would use this later.
7+
8+
# Clone your fork to your local machine
9+
This simply means getting a copy of the repository on your personal computer.
10+
On your computer terminal, cd into the directory you want to clone the repo.
11+
```
12+
cd "directory" note: directory here, should be the name of your chosen directory
13+
```
14+
now, Enter this,
15+
```
16+
git clone "paste the url you copied here"
17+
```
18+
19+
# Create a Branch
20+
To work on a new feature or fix a bug , it's important that you create a new branch. this keeps your changes seperate from the master branch for easy management of multiple pull requests for each completed task.
21+
Enter this
22+
```
23+
git checkout master
24+
```
25+
Create a branch with a name
26+
```
27+
git branch "your-branch-name"
28+
```
29+
30+
## Switch to your new branch
31+
```
32+
git checkout "your-branch-name"
33+
```
34+
35+
Now you can go ahead and effect the desired changes.
36+
37+
## Submitting your changes (a Pull Request)
38+
on your terminal, Enter this to check the modified files
39+
```
40+
git status
41+
```
42+
To add the changes,
43+
```
44+
git add .
45+
```
46+
Commit your changes
47+
```
48+
git commit -m "Add-a-commit-message-here"
49+
```
50+
Now, you can push your changes to the branch you created
51+
```
52+
git push origin "your-branch-name"
53+
```
54+
# Submitting
55+
Once you've committed and pushed all of your changes to GitHub, reload the page for your fork on GitHub, select your branch, and click the green compare and pull request button by the top right, add a description and the number for the issue your pull request and submit.
56+
57+
CONGRATULATIONS ON YOUR SUCCESSFUL CONTRIBUTION :ballons:
58+
59+
If you encounter any issues, feel free to contact us on our [discord channel](https://discord.com/invite/jZQs6Wu).
60+
61+
THANK YOU FOR CONTRIBUTING TO THE EDDIE JAOUDE COMMUNITY
62+

0 commit comments

Comments
 (0)