Skip to content

contributing-guide.md

Latest commit

 

History

History
150 lines (112 loc) · 5.99 KB

contributing-guide.md

File metadata and controls

150 lines (112 loc) · 5.99 KB
Raw

Contributing to authifyChat

A guide on how to get started contributing to authifyChat. Please follow the code of conduct to keep this place safe and always welcoming.

Welcome. We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Updating Database
  • Proposing new feature
  • Becoming a maintainer

The goal of this guide is to

  • Encourage new contributions
  • Encourage contributors to stay involved
  • Create a transparent decision making
  • Make sure maintating database always remains streamlined
  • Make sure the data is and always updated and verified.

Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please follow the steps below

Table Of Content

Updating Database

Reporting a Bug

Report all website related bugs and error here

  • Make sure the issue isn't previously reported. If it already exists, please add as a comment to the existing issue.
  • When creating new issue use the keyword Bug in title.

Proposing New Feature

We would love to hear about your ideas and if it helps in improving the service, we're all in.

  • Create a new issue
  • use the keyword enhancement in the title.
  • If there is a similar idea already mentioned add your comment there and voice your opinion.

Becoming a maintainer

Currently maintainers are chosen my the administrative team depending on how they contributre to this project.

Request new company details

We welcome new company requests. Before you submit a new issue please make sure:

  • It wasn't previously requested.
  • Use the keyword Add in Title (eg Add Paytm)
  • There should only be 1 company per request. (eg: Add Swiggy)
  • Add a link to the main website of the company.
  • If there are other related links, that can be verified from the main website, mention those links on the request(Eg: Twitter page, Customer Support page, customer support/contact email)

Request to update existing company details

It's important to keep the data upto-date to offer the best service for every visitors. Before requesting make sure:

  • It wasn't previously requested
  • Add the keyword Update in Title (eg Update Swiggy url)
  • Add only company name per request
  • Mention what the error is and what the new data is. Make sure the data should be verifiable from the company website.
  • If possible mention the Data Source: in the comment sewction.

Please refrain from submitting new data if you don't know the github workaround and Pull Requests. This is not to discourage you from contributing, but to make sure the data doesn't get corrupted. Here is a great guide on how to start contribuitng to GitHub and getting started with pull requests. Guide on How to Contribute to Opensource

Submitting new Company details

Before opening a pull make sure:

  • It wasn't previously requested
  • Add keyword Added in Title (eg Added: Zebpay)
  • Only add one company per commit.
  • Follow the exisitng data format
  • Make sure all the data are verifiable from the main website. If the links are not verifiable the the PR possibly won't be merged.

Submitting updated company details

Before opening a PR to update exisitng data, make sure:

  • It wasn't previously requested
  • Add keyword Updated: in Title (eg Updated: Paytm Twitter)
  • Add only one company per commit.
  • Follow the exisitng data format
    • Make sure all the data are verifiable from the main website. If the links are not verifiable the the PR possibly won't be merged.

Data Format

It is important to follow the data format to make sure data doesn't get corrupted.

  • Always seperate individual company data with a ,.
  • If the data you submit is accordance with the format given below, the maintainer will close the PR.
  • Follow the below format. You can always refer existing data in case of any doubt

{
"name":"",
"dataType":"",
"url":"",
"supportPage":"",
"email":"",
"twitter":""
},
{
"name":"",
"dataType":"",
"url":"",
"supportPage":"",
"email":"",
"twitter":""
}

where,

Name: Name of Company

dataType: What type of company (Mention the major categorization Banking, ecommerce, travel)

url: website home page

supportPage: Customer Support Page

email: Customer support email

twitter: Twitter page

  • If you cant find all data, leave the respective area blank.
  • If the data you sumbit can't be verified from the main website, refrain from adding these details
  • For twitter page, either it should be linked from main page, or the page should have a verified badge.
  • Lack of complete data won't affect the merging, but id the data can't be verified by the maintainer, they might close it without merging. They will comment on the issue on why it wasn't merged. You can always, reopen it after making necessary changes
  • Any contribution you submit will be copyrighted and licensed accordingly as mentioned in the readme.

An example for a data that'll be approved is given below

{
"name":"Union Bank of India / UBI",
"dataType":"Banking: Public",
"url":"https://www.unionbankofindia.co.in/",
"supportPage":"https://www.unionbankofindia.co.in/english/contact-us.aspx",
"email":"",
"twitter":"https://twitter.com/UnionBankTweets/"


}