ezealot/ez

A Standard for Gaming Slangs

Setting a Standard for Gaming Slangs. 🎮

Table of Contents

• Format
  • Example
• Contributing
  • Workflow
  • Slangs
• Community
• FAQ

Format:

Slang | Actual Word | Definition

Example:

Slang	Actual Word	Definition
EZ	Easy	Self-explanatory

Contributing

Workflow

Please follow standard fork-and-pull workflow.

• Fork the repo on GitHub
• Clone the project locally
• Commit changes to your own branch
• Push the change back to the branch as in the issue

Slangs

Before adding a slang please ensure it is not already present in the database, to help our maintainers clean redundant slangs.

The format for inserting a slang in here is:

Slang_|_ActualWord_|_Definition

where _ represents a space.

Community

Keep up to date and get Esports Zealot support via:

• Discord (to make new friends and engage Strongly Recommended).

FAQ

Q. Does the Slang have to be only acronyms?
A. No, it can be any word or acronym depending on its usage in the community

Q. What if the slang has multiple definitions?
A. That's absolutely possible. In that case make an unordered list of definitions.

Q. How does to make an unordered list of definitions?

Slang	Actual Word	Definition
FPS	First Person Shooter Frames Per Second	Games with camera as the view of the player Graphically how smooth the game is running

ez's Issues

Correct typos in Words.md

Task

Correct typographical errors in Words.md

Description

• Correct the following errors:

  Slang	Actual Word	Description	Error type
  Ambient Occlusion	Shadeows Shadows	Do not touch	Spelling
  HUD	Do not touch	the The	Capitalization
  LoS	Do not touch	reference Reference	Capitalization

Branch

PR in master branch

About Page

Task

Design the about page

Description

• Check for designs in design branch
• Create the design for the about page with the same feel as the other pages

Branch

PR in design branch

Adding a slang page

Task

Add the Slang Page

Description

• Check the design here
• Add a similar Slang page to the existing website or create a new one
• The page initially displays all entries in the database
• For multiple entries for the same keyword check FAQ

Branch

PR in gh-pages-dev branch

Add a banner to ReadMe

Task

Add a banner to ReadMe in design branch

Description

• Remove the heading Esports Zealot
• Add a banner of 1400x500 px with the logo and the name

Branch

PR in design branch

Words

Task

Add a file named as : Words.md

Description:

• The file needs to contain as many gaming slangs as possible according the format specified in the ReadMe.
• Keep it to only one PR

Branch

PR in docs branch

Database required

Task

Database needs to be added and populated with the entries in words.md file in docs branch

Description

• A sqlite file needs to be added
• Set the file name to wordbase
• Set the primary key to be slang , check Format

Branch

PR in web branch

Update Words.md

Task

Update Words.md

Description

• Compare the present definitions with the ones present in the internet
• Update the definitions wherever necessary
• Check the file for any typographical error and correct them
• Add new entries

Branch

PR in [master] branch

Slang Page

Task

Design the slang page

Description

• Check for designs in design branch
• Create the design for the slang page with the same feel as the other pages

Branch

PR in design branch

Front end

Task
The structure of the website needs to be created

Description

• Creating base structure
• Depend on #2 or could build a base structure and edit that later

Branch
PR in web branch

Update Words.md

Task

Increase the number of words

Description

• Introduce at least 30 new entries currently it's just 6

Branch

PR in docs branch

Search bar

Task

Slang page and search bar coupling

Description

• The page initially displays all entries in the database
• For multiple entries for the same keyword check FAQ
• The search bar searches the keyword from the sqlite database and fetches the related info and displays it on the slang page
• The results are displayed on the "Slang" page

Branch

PR in web branch

Design a logo

The name of the page is -
Esports Zealot shortened to EZ for historical gaming reasons 😉

IMP
Send PR to design branch

Front end for the website

Task

Make the remaining front end of the website

Description

• Check the design branch to get a feel of how the homepage should look
• Make a similar front end, using the resources of web branch
  OR
  Make a similar front end, using any framework you are comfortable with

Branch

PR in web branch

Cross-platform

Task

Make the website cross platform

Description

• Make the website cross-platform
• Currently the website shows all functionalities in:
• Google Chrome (tested)
• Vivaldi (tested)
• Microsoft Edge (tested)
• Mozilla Firefox browser (tested)
• Safari

Branch

Please put the PR in gh-pages-dev branch

Website Designs

Website design assets

PR to Branch - design

Change the navbar

Task
The frontend navbar needs to be changed from the web branch

Description

• Take a look at design branch to know how the webpage should look
• Change the nav bar

Branch
PR to web branch

Search bar

Task

Make a search bar for the website

Description

• Check the design branch to see how the search bar looks
• Make a similar searchbar

Branch

PR in web branch

Add words

Task

Increase the number of words in words.md in docs branch

Description

• Add 40 or more new entries

Branch

PR in docs branch