IDEA
Emoticon suggestor is a web tool which can be used to suggest emoticons according to words that are being typed and in the context of user's sentence.
AIM
Motive behind starting this project is to make open source awareness among students and to create team work skills so that in future they won't face any issue in using collaborative tools like git/github, codespaces, etc.
How
-
Register for hacktober 2021 by visiting https://hacktoberfest.digitalocean.com/ and make sure you check the participant checkbox in your profile.
-
Then come back here, find opened issues to work on and make sure the issue you are working on is not assigned to anybody else there to avoid duplicate work. If you found no opened issue, you can open a new if you'd like to create new feature, report bug, edit this documentation, etc. These all things will be counted in your hacktober profile after we accept your pull request with "hacktober-accepted" label. Read next points to work on how to contribute.
-
First of all fork this repository by fork button in top right of screen:
-
Clone this forked repository from YOUR github account to your local machine, change directory into project folder and run start command:
git clone [your forked repositoy link]
cd emoticon-suggestor
npm install
npm start- Create features, modify code, do your stuff.
- After testing all features, create new branch (keep branch name conventional so that it would be easy to review and merge them, for example you are building light theme, then branch name could be "lighttheme"), push your changes to this branch locally and remotely.
- Now to create a pull request, head over to your github account, if you pushed your changes perfectly you will see a "compare and create pull request" button on top of your repository:
click that and add title and description. Note: Mention issue number in your title that you fixed, for example Fixes #[issue number] or Resolves #[issue number].
- After that, wait for your PR to be review and merged.
Your benefits
-
You will get limited edition t-shirts if you do quality PR's or issues, and they got accepted under hacktoberfest-accepted label, make sure to read official hacktoberfest requirements to make you eligible to win goodies.
-
If you will be one of major contributors in this project, we will ask you to work as collaborator on upcoming projects and you will be featured on our platform.
-
Other perks and rewards are under discussions, stay up to dated with us.