Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync main with develop #116

Merged
merged 13 commits into from
Mar 9, 2021
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
max_line_length = 120
tab_width = 2
trim_trailing_whitespace = true
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
node_modules
node_modules
59 changes: 33 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,139 +8,146 @@
# File Structure

```
├── index.html For homepage HTML page
├── index.html For homepage HTML page
├── css All the styling goes here
│   ├── common
│   ├── pages
├── img All the images go here
│   ├── logos
│   ├── pages
├── code-of-conduct.html For code of conduct HTML page
├── discord.html For the discord help HTML page
├── discord.html For the discord help HTML page
├── faq.html For FAQs HTML page
├── navbar.html For the navigation bar
├── CONTRIBUTING.md Contribution file
├── CONTRIBUTING.md Contribution file
├── README.md README file for the repository
```

# How can you make your first **Pull Request**

**Note**: Steps 1, 2 and 3 are **one-time** steps required for setup. If you have already cloned the repo and added upstream, consider following this documentation from step 4.

1. **Forking repository**

1. **Forking repository**

Fork this repository using the **Fork** option at the top-right corner of this page. This will create your own copy of this repository. You'll be redirected to your forked repository. Copy the link of this repository (which will look like `https://github.com/<your-username>/website-welcome/`) as you'll need it in the step 2.

![how-to-fork](https://i.imgur.com/VfoTxmy.png)

2. **Cloning repository**


Clone your forked repository, this will download your copy of repository in your computer. To do this, open your terminal (command prompt/bash/git bash) and enter the following command, paste your link after the word **clone** without the **<>**.
```

```
git clone <link which you copied in the step 1>
```

3. **Adding remote repository**


Add the Real Dev Squad repository as a remote repository, so that you can anytime pull the latest changes from the Real Dev Squad repository which is being deployed. This needs to be done only for the first time.
```
git remote add upstream https://github.com/Real-Dev-Squad/website-welcome/

```
git remote add upstream https://github.com/Real-Dev-Squad/website-welcome/
```

4. **Getting the latest code from the develop branch** (Can be skipped if you've cloned the repo just now)

If it's been quite a while after you have cloned the repo/made the last pull request, it's recommended to take a pull from the develop branch. Reason being, there may be some changes which could have merged after you had cloned the repo/made the last pull request.

To do so, make sure you're in the develop branch by checking out to the **develop** branch:

```
git checkout develop
```

Once you're in the **develop** branch, it's time to take a pull:

```
git pull upstream develop
```

Now that you've made sure that you've got latest changes, we can proceed to creating our branch


5. **Creating a new branch**

Let's create a new branch to work on. We require a different branch so that we always have a stable, working version in the default (develop) branch. We're not supposed to touch the **main** branch as it is the one getting deployed on production.
```
git checkout -b <branch-name>

```
git checkout -b <branch-name>
```

We will try to name the branch according to the task we are going to perform in it. If it is going to be a `feature`, the branch name should begin with `feat` or `feature`. If it is going to be a `fix`, the branch name should begin with `fix` or `bugfix`. The branch name should be self-explanatory.
For example, if I want to work on a `feature` called `login-form`, the branch name will be **feature/login-form**. If it is going to be a `fix` in `navbar`, the branch name will be `fix/navbar`.
For example, if I want to work on a `feature` called `login-form`, the branch name will be **feature/login-form**. If it is going to be a `fix` in `navbar`, the branch name will be `fix/navbar`.
Command example:
```

```
git checkout -b feature/login-form
```


6. **Just do it!**


Perform the tasks you wanted to, can be anything, ranging from fixing simple typo to re-designing the whole page!

7. **Committing your changes**


Now you have made the changes, though they are saved in your system, Git doesn't know what changes you've done. So you have to **commit** your changes. First step is to add the files which you want to add to the staging area, the dot after **add** in the first command tells Git to check for changes in all the files. The second step is about committing your changes. The message part is short description of your commit, like "adds a login form on homepage". Please make sure NOT to have commit messages like "fix issue#34". When we look at the commit history, we should understand what a particular commit is supposed to do based on the commit message.
```

```
git add .
git commit -m "Write message about your commit"
git commit -m "Write message about your commit"
```

8. **Making sure you have the latest changes from the develop branch**

It may so happen that since the last time you cloned the repo/took a pull from develop, some changes may be merged in the develop branch. So to be on the safer side, we should have those changes as well.

In order to do that, we first checkout to **develop** branch by:

```
git checkout develop
```

Once we're in develop, it's time to take a pull:

```
git pull upstream develop
```

Now that our **local** develop branch is in sync with **remote** develop branch (of the Real Dev Squad Repository), we should let our branch know about the changes from the develop branch (if any). To do so we first checkout to our branch:

```
git checkout <branch-name>
```

Once we're in our branch, we **rebase** our branch on top of the current develop branch (we change the base of our branch, so that it appears as if we have worked from the time the latest changes were merged in the develop branch). To do so:

```
git rebase develop
```

You should solve the merge conflicts, if any.

9. **Pushing the code**

Now that we have made our changes plus we have the latest changes made by other contributors, we should push our code from **local** branch to the same branch on our **GitHub fork**. We do so by:

```
git push origin <branch-name>
```

For example, if the branch name is `feat/login-form`, we enter `git push origin feat/login-form`

The **origin** refers to your GitHub fork. You can check it by entering `git remote -v`, you should the link to your fork against **origin**.


10. **Making a pull request**

Your GitHub fork now has the changes, but you want those changes to be merged in the Real Dev Squad repository, right? There's a twist, you can't directly merge your code in the Real Dev Squad. Imagine you own a company whose code is open sourced, would you like if anyone could code make changes in the directly without asking you? For the same reason, **Pull Requests** exist. You `request` the repository maintainers/admins to `pull` your code in their repository.

To make a pull request, go to your **forked repository** and you'll see **<branch-name> had recent pushes less than a minute ago** . Right next to it will be an option to **Compare & pull request**. Click on it, submit your pull request (also known as *PR*) explaining what you've done. Again, the PR title should be self-explanatory but concise. If you want to write details, you can add it in the description. If you're making some UI (User Interface) changes, please make sure to add a short screen recording. If that's not possible, at least add some screenshots.
To make a pull request, go to your **forked repository** and you'll see **<branch-name> had recent pushes less than a minute ago** . Right next to it will be an option to **Compare & pull request**. Click on it, submit your pull request (also known as _PR_) explaining what you've done. Again, the PR title should be self-explanatory but concise. If you want to write details, you can add it in the description. If you're making some UI (User Interface) changes, please make sure to add a short screen recording. If that's not possible, at least add some screenshots.

![how-to-create-pull-request](https://i.imgur.com/zYSuNY7.png)

11. **Review stage**

Now the maintainers/admins will review your pull request. They might suggest some changes if required. You should then make the required changes in the **same branch**, commit them and push your changes to the **same branch** (follow the steps 7, 8 and 9 for the same).




12. **Congratulations on your first Pull Request in Real Dev Squad! 🎉**
12. **Congratulations on your first Pull Request in Real Dev Squad! 🎉**
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

https://welcome.realdevsquad.com/


# Want to contribute or Learn how to?

Read about our Contributing Process: [Here](CONTRIBUTING.md)
Expand All @@ -13,10 +12,10 @@ Read about our Contributing Process: [Here](CONTRIBUTING.md)

https://welcome.realdevsquad.com/faq

# Help with Discord
# Help with Discord

https://welcome.realdevsquad.com/discord

# Code of conduct at RDS

https://welcome.realdevsquad.com/code-of-conduct.html
https://welcome.realdevsquad.com/code-of-conduct.html
42 changes: 13 additions & 29 deletions code-of-conduct.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@
<link rel="stylesheet" type="text/css" href="./css/pages/navbar.css" />
<link rel="icon" type="image/x-icon" href="./img/logos/favicon.ico" />

<link
href="https://fonts.googleapis.com/css2?family=Roboto:wght@100;400&display=swap"
rel="stylesheet"
/>
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@100;400&display=swap" rel="stylesheet" />
</head>
<body>
<header>
Expand All @@ -36,54 +33,41 @@
<article>
<h1 class="welcome-title">Code of Conduct at RDS</h1>
<p class="coc-header">
We are dedicated to building a positive environment that inculcates open
learning and high respect for one another. So we expect our members to maintain
a certain decorum.
We are dedicated to building a positive environment that inculcates open learning and high respect for one
another. So we expect our members to maintain a certain decorum.
</p>

<ul class="coc-list">
<li class="coc-list-elements">
No trolling of members on the group. We are here to learn and help each other
grow.
No trolling of members on the group. We are here to learn and help each other grow.
</li>
<li class="coc-list-elements">
No spamming off topic stuff. Time is the most important resource. Lets save it
in manifolds by reducing off topic content.
No spamming off topic stuff. Time is the most important resource. Lets save it in manifolds by reducing off
topic content.
</li>
<li class="coc-list-elements">
Avoid Direct Messages. Do not hesitate to ask your queries on the #support
discord channel. Aids in quicker response.
</li>
<li class="coc-list-elements">
Avoid using tags @everyone and @here until it is very important.
Avoid Direct Messages. Do not hesitate to ask your queries on the #support discord channel. Aids in quicker
response.
</li>
<li class="coc-list-elements">Avoid using tags @everyone and @here until it is very important.</li>
<li class="coc-list-elements">Google your queries before you seek help.</li>
<li class="coc-list-elements">
When seeking help, submit the code in an easy-to-evaluate fashion. Share a
<a href="https://codepen.io/" target="_blank" rel="nopener norefer"
>Codepen </a
>link instead of a
<a href="https://github.com/" target="_blank" rel="nopener norefer">Github </a
>link.
<a href="https://codepen.io/" target="_blank" rel="nopener norefer">Codepen </a>link instead of a
<a href="https://github.com/" target="_blank" rel="nopener norefer">Github </a>link.
</li>
<li class="coc-list-elements">
Overall challenge yourself. Take up tasks proactively and update your progress
</li>
<li class="coc-list-elements">
It helps to have a picture of yourself on your Discord & Github profiles.
</li>
<li class="coc-list-elements">It helps to have a picture of yourself on your Discord & Github profiles.</li>
</ul>
</article>
</main>

<footer>
<p class="info-repo">
The contents of this website are deployed from this
<a
href="https://github.com/Real-Dev-Squad/website-welcome"
target="_blank"
rel="nopener norefer"
>
<a href="https://github.com/Real-Dev-Squad/website-welcome" target="_blank" rel="nopener norefer">
open source repository
</a>
</p>
Expand Down
1 change: 0 additions & 1 deletion css/common/main.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 10 additions & 1 deletion css/common/main.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 6 additions & 13 deletions css/pages/discord-old.css
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@



.discord-wrapper {
margin-left: 5%;
}

.main-heading {

text-align: left;
font-weight: 600;

Expand All @@ -16,36 +12,33 @@
.get-started {
text-align: left;
font-weight: 550;

}
.discord > *{
.discord > * {
text-align: left;
font-weight: 500;
font-size: 1em;
margin-block-start: 1em;
margin-block-end: 1em;
margin-inline-start: 0px;
margin-inline-end: 0px;

margin-inline-end: 0px;
}

.discord-info {

text-align: left;
font-weight: 500;
font-size: 1em;
margin-block-start: 1em;
margin-block-end: 1em;
margin-inline-start: 0px;
margin-inline-end: 0px;
margin-block-end: 1em;
margin-inline-start: 0px;
margin-inline-end: 0px;
}

.container {
margin-top: 30px;
margin-bottom: 40px;
}

.category-img{
.category-img {
margin-left: 2px;
width: 61%;
}
Expand Down
12 changes: 9 additions & 3 deletions css/pages/discord.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.