Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

64 lines (50 loc) · 2.69 KB
Raw

Contributing to Swot

Data Contributions

  • All of the school data is stored in a simple filesystem data structure under lib/domains.
  • Every directory name in here is a TLD (Top Level Domain) e.g. edu.
  • Every file in these directories is named after the school's SLD (Second Level Domain) e.g stanford.
  • The contents of that file are simply the school name e.g. Stanford University.
  • The working example for Stanford University 👀
  • Here's what the data structure looks like:
[-] lib
    [-] domains
        [-] ac.uk
            [+] strath
        [-] edu
            [+] harvard
            [+] stanford
Adding a School

Let's say you want to add the University of Strathclyde. We know the TLD is ac.uk and the SLD is strath. We'd simply create a file at lib/domains/ac.uk/strath containing the text University of Strathcylde. You can safely ignores subdomain like www, cis, whatever. You can see the actual file here.

Updating a School Name

Change the file contents of the appropriate file.

Deleting a School Name

A simple git rm on the approriate file will do the trick.

Code Contributions

This was literally my first Ruby gem, so please keep that in mind when you're looking at the code :trollface:

  • Check out the latest master.
  • Take a look through the open pull requests in case someone else has already contributed something similar.
  • Fork the project.
  • Start a topic branch of your own.
  • Commit and push away. Don't forget the tests!
  • Submit a pull request.
  • 💥 You've contributed to open source!
     ____________________________________________________
    |.==================================================,|
    ||  I WILL MERGE AND REVIEW PULL REQUESTS QUICKLY   ||
    ||  I WILL MERGE AND REVIEW PULL REQUESTS QUICKLY   ||
    ||  I WILL MERGE AND REVIEW PULL REQUESTS QUICKLY   ||
    ||  I .----.ERG,                                    ||
    ||   / ><   \  /                                    ||
    ||  |        |/\                                    ||
    ||   \______//\/                                    ||
    ||   _(____)/ /                                     ||
    ||__/ ,_ _  _/______________________________________||
    '===\___\_) |========================================'
         |______|
         |  ||  |
         |__||__|
         (__)(__)