THATConference.com

Contributing

Types of contributions we are looking for
Ground rules and expectations
How to contribute
Style guide
Setting up your environment
Community

1. Types of contributions we are looking for

There are many ways you can contribute, here are just some of the broader items we love to have help from the community on:

Find a bug, report a bug... if/when you find something please let us know! We count on your eyes to spot things we miss. Open an issue and will will follow up and prioritize.
Grab an issue to fix. See an open issue you would like to tackle? Go for it! Assign yourself the issue and get started.
Review open pull requests. If there an an open PR of changes, review it! Eyes and feedback on incoming work is appreciated by all!

2. Ground rules and expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
THAT Conference has a released Code of Conduct. By participating in this project, you agree to abide by its terms.
If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.

3. How to contribute

The best place to start is the open issues. Any ones we feel are a great first step into the code base we have labeled as good first issue. But don't feel limited to just those issues. Any open issue is up for grabs to be worked on.

Find one you would be interested working on, assign yourself and get started! Once complete open a pull request and label as ready for review. Want to pull more community in? Yeah you do! Mention in THAT Slack or on the socials that you have a PR that needs to be reviewed. We love having community involvement across the entire flow.

Once your PR is reviewed and the specs pass, THAT Crew will give me one last run through and merge.

4. Style Guide

Coming soon

5. Setting up your environment

THAT website is server-side rendered React via Next. To get started, clone the repo and run npm install to get all the dependencies in place. Also run npm i -g now to install Zeit Now globally on your machine.

If you are on a mac, it is helpful to make sure Xcode and Xcode command line tools are up to date.

Run cp .env.sample .env && cp .env.build.sample .env.build to get basic configuration in place.

Edit the .env.build file:

DEBUG=that:*
SESSION_COOKIE_SECRET requires at least a 32 character value.
API_GATEWAY should be https://api.that.tech

Edit the .env file, adding

DEBUG=that:*
SESSION_COOKIE_SECRET requires at least a 32 character value.
API_GATEWAY=https://api.that.tech

Edit package.json

Change the Auth0 module version number to 0.7.0 (be sure to remove the ^ before the version name)

After you edit those files, run now dev to startup localhost.

6. Community

THAT is all about community. It was bringing the community together that inspired the creation of THAT Conference. Participating in the development of our website is a way for us to extend our community.

Assume good intentions. Keep discussions within issues and pull requests so all can participate.

File Organization

The pages directory contains a file for each page of the site.

components directory is where you will find all components used across all pages. shared contains components used across multiple pages.

Any components specific to a page are grouped together in the same folder.

If a component has sub-components it concludes (i.e. footer) all of those components will be within the same folder.

Styles

THAT Website utilizes styled-components. 1rem = 10px

Tests

We utilize Jest + Enzyme to unit test each component. Each component should be covered with a spec to ensure it renders without error as well any additional functions that component relies on to render correctly.

Feature/Page Development

In order to iterate collectivlely when developing a new page we have a higher order component you can wrap your page component around so that it is only rendered for a matching query param.

Here is how it works, in your .env file give FEATURE_KEYWORD some value. Then wrap your page componet (NOTE: currently only works for pages) in togglePage. This adds the logic that will allow this page to render only when a query param is present and matches the value set in FEATURE_KEYWORD.

Example - Check out samples/toggle-page.js. Here is a sample page wrapped in togglePage. Now, set FEATURE_KEYWORD in your .env to a value, let's go with baconisgreat, then fire up the local environment. Go to: http://localhost:3000/samples/toggle-page?feature=baconisgreat and page will load. Go to: http://localhost:3000/samples/toggle-page?feature=baconisgood, page not found Go to: http://localhost:3000/samples/toggle-page, page not found

shaunpkennedy/that-website