Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 4.87 KB

README.md

File metadata and controls

75 lines (51 loc) · 4.87 KB
Raw

Ruby Companies

GitHub Workflow Status (with branch)

Important

Currently, no pull requests for version 1 are accepted. Work on version 2 as a Ruby on Rails app with self-support has started. You can find the current progress in the version-2 branch and the Ruby Companies v2 project board. Contributions are welcome!

ruby-companies.org is a simple list of companies developing software with Ruby, published collaboratively with the Ruby community. This project is heavily inspired by RubyConferences.org.

Eligible Companies

For now, any company that works with Ruby (or a framework based on Ruby). Especially contributions of smaller companies are welcome!

Contributing

The list of companies is driven by the src/_companies directory.

Adding a company

If you want to add a company, create a file with the following structure: src/_companies/{continent}/{country}/{region}/{company}/index.md. Then add at least the required YAML keys (see below) and send a PR.

Updating a company

If you want to update a company, identify the markdown file and update the outdated or missing information and send a PR.

List of keys

Here is a list of the keys that can be used:

Required

  • name: The name of the company.
  • continent: The continent of the company headquarter.
  • country: The country the company headquarter is based in.
  • region: The region the company headquarter is based in.
  • city: The city the company headquarter is based in.
  • website: The url of the company website.
  • created_at: The timestamp when the company was added to Ruby Companies. We use this to determine the newest companies. The easiest way to generate is: bin/bridgetown company:timestamp. This will generate a UTC timestamp of the current moment.

Optional

  • careers_page: A url of the careers page for the company.
  • work_arrangements: An array of the work arrangements the company offers. Possible values: remote, hybrid, onsite.
  • stack: An array that describes (part of) the stack that the company uses. The first three values are also shown on the overview list, so it's important to hire the key tech here (usually language/framework, database, frontend framework). For a list of already added stacks see src/_data/stacks.yml. Feel free to add new values in that file. The klasses value contains TailwindCSS classes. The text class color should be based on the brand color. This tool can be used to find the closest Tailwind color from the palette. The background color should be the same color, but the -100 shade of it. You can deviate from this if it doesn't look good.

Company description

Below the YAML keys (which use the front matter format) you can write text in the markdown format to briefly introduce the company. Please use the third person ("they"). While an employee of a company can talk about the company in the first person ("we"), an open source contributor who doesn't belong to a company never can. By sticking to third person, everyone can contribute to company descriptions.

If you have a hard time coming up with a company description, you can try to ask ChatGPT. An example prompt would be: Write me a short, neutral summary of the company {company name} in less than 100 words.

Company logo

You can add a logo for the company. Currently, we suggest svg, png or jpg images with a resolution of 200x200 pixels. The image can be larger than that, but it has to be square. Please keep in mind we're not an image hosting service, so use optimized assets. The maximum file size should be 50KB. If you have a hard time finding a logo, you might find a suitable variant on the LinkedIn profile of the company you're trying to contribute an entry for.

In case you want to contribute additional image assets, please prefix them with an underscore so they're not exported in the build process (e.g. _original_logo.png).

Getting started

The website is built with Bridgetown.rb.

Install Ruby, then:

cd ruby-companies
bundle install && yarn install
bin/bridgetown start

and point your browser at http://localhost:4000/

In case you want to submit a contribution:

  1. Fork the repository
  2. Clone the fork using git clone to your local development machine.
  3. Create your contribution branch (`git checkout -b my-contribution
  4. Commit your changes (git commit -am 'Add ACME company')
  5. Push to the branch (`git push origin my-contribution
  6. Create a new Pull Request

License

I'm not sure what the best license for this would be, but I'm open to suggestions.