forked from Anadee11/WebArena
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
157 additions
and
4 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 |
|---|---|---|
|
|
@@ -61,7 +61,7 @@ representative at an online or offline event. | |
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| [INSERT CONTACT METHOD]. | ||
| [email protected] . | ||
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
|
|
@@ -115,6 +115,7 @@ community. | |
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), | ||
| version 2.1, available at | ||
| [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
| https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
|
|
||
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 |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Contributing guidelines | ||
|
|
||
| ## Before contributing | ||
|
|
||
| Welcome to [WebArena](https://github.com/anadee11/WebArena). Before sending your pull requests, make sure that you **read the whole guidelines**. If you have any doubt on the contributing guide, please feel free to email me on [email protected] . | ||
|
|
||
| ### Contribution | ||
|
|
||
| We appreciate any contribution, from from a very basic project to some cool projects. Please read this section if you are contributing your work. | ||
|
|
||
| #### Folder Structure | ||
|
|
||
| We want your work to be readable by others; therefore, we encourage you to note the following: | ||
|
|
||
| - Make a new folder with name of the project you are contributing. | ||
| - In this folder, put the files and a readme.md file. | ||
| - The readme.md file should describe the project. | ||
|
|
||
|
|
||
| #### Other points to remember while submitting your work: | ||
| - Won't be accepting PR's without issues being raised and assigned. | ||
| - Avoid infringement with the code of other projects, do not make your folder inside the other project . | ||
| - Do not update the README.md and CONTRIBUTING.md. | ||
| Happy Coding :) |
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 +1,129 @@ | ||
| # WebArena | ||
| # <p align="center" width="100%"> </p> | ||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
|
|
||
|
|
||
| [](https://opensource.org/licenses/MIT) [](https://github.com/ellerbrock/open-source-badges/) [](http://makeapullrequest.com)   | ||
| </p> | ||
| A beginner friendly project to help you in open source contributions. An attempt to bring Web Projects together. | ||
|
|
||
|
|
||
| **Please see the <a href="https://github.com/Anadee11/WebArena/blob/main/CONTRIBUTING.md"> **Contributing Guidelines** </a>.** | ||
|
|
||
|
|
||
| ## Overview | ||
|
|
||
| The goal of this project is to help the beginners with their contributions in Open Source and to bring all the Web projects together. We aim to achieve this collaboratively, so feel free to contribute in any way you want, just make sure to follow the contribution guidelines. | ||
|
|
||
|
|
||
| ## What is Open - Source? [](https://github.com/ellerbrock/open-source-badges/) | ||
| The open source community provides a great opportunity for aspiring programmers to distinguish themselves; and by contributing to various projects, developers can improve their skills and get inspiration and support from like-minded people. When you contribute to something you already know and love, it can have so much more meaning, because you know how the tool is used and the good it does for you. Being part of an open source community opens you up to a broader range of people to interact with. | ||
|
|
||
| Read more about it <a href="https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source"> here. </a> | ||
|
|
||
|
|
||
| ## <u> Let's Get Started: </u> | ||
|
|
||
| ### Step 1. Create a Copy of this Repository | ||
| In order to work on an open-source project, you will first need to make your own copy of the repository. To do this, you should fork the repository and then clone it so that you have a local working copy. | ||
|
|
||
| > **Fork :fork_and_knife: this repo. Click on the Fork button at the top right corner.** | ||
| With the repository forked, you’re ready to clone it so that you have a local working copy of the code base. | ||
|
|
||
| > **Clone the Repository** | ||
| To make your own local copy of the repository you would like to contribute to, let’s first open up a terminal window. | ||
|
|
||
| We’ll use the git clone command along with the URL that points to your fork of the repository. | ||
|
|
||
| * Open the Command Prompt | ||
| * Type this command: | ||
|
|
||
| ``` | ||
| git clone https://github.com/your_username/WebArena | ||
| ``` | ||
|
|
||
| <kbd><img width="633" alt="Screenshot 2022-10-04 at 2 53 53 AM" src="https://user-images.githubusercontent.com/73078636/193685501-b92510c3-2b9d-401c-abe0-834b4fdfccab.png"></kbd> | ||
|
|
||
|
|
||
|
|
||
| ### Step 2: Creating a New Branch | ||
| It is important to branch the repository so that you are able to manage the workflow, isolate your code, and control what features make it back to the main branch of the project repository. | ||
|
|
||
| When creating a branch, it is very important that you create your new branch off of the master branch. | ||
| **To create a new branch, from your terminal window, follow:** | ||
|
|
||
|
|
||
| ``` | ||
| git branch new-branch | ||
| git checkout new-branch | ||
| ``` | ||
| Once you enter the git checkout command, you will receive the following output: | ||
|
|
||
| ``` | ||
| Switched to branch 'new-branch' | ||
| ``` | ||
|
|
||
|
|
||
| ### Step 3: Contribute | ||
| - Make relevant changes.Add new projects(make sure to put in the readme files in your folders). | ||
| - Contribute with any web project you feel like :) | ||
|
|
||
| ### Step 4: Commiting and Pushing: | ||
| Once you have modified an existing file or added a new file to the project, you can add it to your local repository, which we can do with the git add command. | ||
|
|
||
| ``` git add filename``` or ``` git add .``` | ||
|
|
||
| You can type the command ```git add -A``` or alternatively ```git add -all``` for all new files to be staged. | ||
|
|
||
|
|
||
| **With our file staged, we’ll want to record the changes that we made to the repository with the ```git commit``` command.** | ||
| <p> The commit message is an important aspect of your code contribution; it helps the other contributors fully understand the change you have made, why you made it, and how significant it is. </p> | ||
|
|
||
| ``` | ||
| git commit -m "commit message" | ||
| ``` | ||
|
|
||
|
|
||
| At this point you can use the ```git push``` command to push the changes to the current branch of your forked repository: | ||
| ``` | ||
| git push --set-upstream origin new-branch | ||
| ``` | ||
|
|
||
| ### Step 6: Create Pull Request | ||
| At this point, you are ready to make a pull request to the original repository. | ||
|
|
||
| You should navigate to your **forked** repository, and press the “Compare & pull request” button on the page. | ||
| <kbd><img width="911" alt="Screenshot 2022-10-04 at 3 21 21 AM" src="https://user-images.githubusercontent.com/73078636/193692534-54eb66df-9f17-40fc-accd-deca18f802fd.png"></kbd> | ||
|
|
||
| GitHub will alert you that you are able to merge the two branches because there is no competing code. You should add in a **title**, a **comment**, and then press the **“Create pull request”** button. | ||
|
|
||
| <kbd> | ||
| <img width="912" alt="Screenshot 2022-10-04 at 3 24 21 AM" src="https://user-images.githubusercontent.com/73078636/193692962-69677f51-c1ec-4ee8-b123-012de4411434.png"> | ||
| </kbd> | ||
|
|
||
| ### Step 7: CONGRATULATIONS :boom: :clap: :relaxed: | ||
| You have made it till the end. Kudos to you!! | ||
|
|
||
| <hr> </hr> | ||
|
|
||
| ### How to upload the files | ||
|
|
||
| * Upload your folders with the corresponding files and a readme.md file. | ||
| * **Under no circumstances create new folders or directly upload files within the folders of other projects.** | ||
|
|
||
| #### Please see the <a href="https://github.com/Anadee11/WebArena/blob/main/Contributing.md"> **Contributing Guidelines** </a>. | ||
|
|
||
| <hr> </hr> | ||
|
|
||
| ## Please STAR :star2: this repository if you liked it and had fun :) | ||
|
|
||
| ### Maintainer! :blush: | ||
|
|
||
| <table> | ||
| <tbody><tr> | ||
| <td align="center"><a href="https://github.com/geekquad"><img alt="" src="https://avatars.githubusercontent.com/anadee11" width="100px;"><br><sub><b>Anadee</b></sub></a><br><a href="https://github.com/anadee11" title="Code">💻 🖋</a></td> </a></td> | ||
| </tr> | ||
| </tbody></table> | ||
| <hr> | ||
|
|