For participation, please visit : https://aos.sanscript.tech/
Here are some guidelines you need to follow for contributions.
- Please register for the event to contribute and join our slack channel (mandatory). You will receive a confirmation mail and link for joining slack channel through the mail.
- Please specify your full name on your GitHub profile for review.
- Each participant will be assigned 2 issues (max) at a time to work.
- Participants have 7 days to complete issues.
- Participants have to comment on issues they would like to work on, and mentors will assign you.
- Issues will be assigned on a first-come, first-serve basis.
- Participants can also open their issues, but it needs to be verified and labelled by a mentor.
- Before opening a new issue, please check if it is already created or not.
- Issues labelled with AOS2020 are only eligible.
- Pull requests will be merged after being reviewed by a mentor.
- Create a pull request from a branch not from Main.
- You will be scored based on the level of issues you have solved.
- It might take a day to review your pull request. Please have patience and be nice.
- We all are here to learn. You are allowed to make mistakes. That's how you learn, right!
- Reach out to mentors if you need help through the slack channel.
Pull Requests review criteria:
- Please mention parent issue no. with "#" in the description while sending a pull request.
- You must add your code file into the respective language folder.
- Your work must be original, written by you not copied from other resources.
- You must comment on your code where necessary.
- Add a readme file which must contain:-
- description of your issue you have solved.
- use case.
- sample input and output.
- for issues labelled with medium or high, please add relevant output images in a seperate folder.
- please add all the images in a separate folder to make you contribution look clean.
The Event will end on 20 November 2020. We will provide a certificate of contribution to the participant with at least one pull request merged.
Mentors/Maintainers of the project:-
- @tejan-singh
- @yashaswibiyahut
- @balapriyac
- @SANKET7738
For queries regarding registration, participation, certification and rewards, reach out for help at [email protected]
Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.
Open a terminal and run the following git command:
git clone "url you just copied"where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
For example:
git clone https://github.com/sanscript-tech/hacking-tools-scripts
Change to the repository directory on your computer (if you are not already there):
cd (filename)
Now create a branch using the git checkout command:
git checkout -b your-new-branch-nameFor example:
git checkout -b dev_username
Do the necessary changes.
If you go to the project directory and execute the command git status, you'll see there are changes.
Add those changes to the branch you just created using the git add command:
git add .
Now commit those changes using the git commit command:
git commit -m "(Add your message here)"replacing <Add your message here> with your message.
Push your changes using the command git push:
git push origin <branch-name>replacing <branch-name> with the name of the branch you created earlier.
If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.
Now submit the pull request.
Soon we will be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.