2017.djangocon.us Website

The 2017 DjangoCon.us website is a static site compiled with Jekyll. The frontend relies heavily on the Foundation framework. Frontend dependencies are installed and updated with npm, and complied for production using Gulp.

Code of Conduct

As a contributor, you can help us keep the Django community open and inclusive. Please read and follow our Code of Conduct.

Getting Started

Get started contributing by reading our Contributing guidelines.

Contributing via Browser

1. Navigate to the DjangoCon U.S. website repo on GitHub. In the upper right hand corner of the repo, click the "Fork" button. Alternatively, click on an individual file and click the pencil icon. GitHub will automatically fork the repo for you.

2. Head over to your GitHub account, where you will find the forked repo. This is a copy of the official code. Your changes to this forked code will not affect the official code, unless you submit a pull request and an admin merges your pull request.

3. For changes that do not need to be tested locally, the change can be made and submitted in the browser, without cloning the repo locally.

4. Within your forked repo, click on the "Branch" tab and choose the "design" branch. During development, most updates are made to the branch being used for development (in this case, the "design" branch) and merged by an admin with the master branch when ready for production.

5. Once you are on the correct branch, navigate to the file you intend to change and click the pencil icon to open it. Make the change and click the "Commit changes" button.

6. Staying within your forked repo, navigate back to the main page of the branch (note: your pull request should be submitted via your forked repo, not the main repo). Click "New pull request." Click the "Commit changes" button. At the "Comparing changes" page, double check that you are happy with your proposed change. If so, click "Create pull request." Add a descriptive title and comment if applicable, then click "Create pull request" at the bottom to submit. An admin will review your proposed change, merge it, or give you feedback.

Example: Updating Organizer Info

Follow the above instructions to 5. Click on the _data folder, then organizers.yml file. Click on the pencil icon to open the file. Make your changes, making sure that your information is placed within quotation marks. Complete step 6.

Contributing via Local Development

For changes that require cloning/running the code locally, follow the instructions to step 5. Instead of navigating to the file through the browser, open up your computer terminal (you will need to have git installed locally and probably a code editor of your choice).

Clone your forked repo locally via the terminal, replacing the username in the URL with your own (note: not all operating systems will use a $ as a terminal prompt).

$ https://github.com/your-username/2017.djangocon.us

Change directory into the folder

$ cd 2017.djangocon.us

To work on the development branch (called "design"), change to that branch

$ git checkout design

Verify that you are on the design branch

$ git branch

Follow the instructions below to run the website on a local server. GitHub recommends using Bundler to install and run Jekyll. Ruby is a pre-requisite. See the Jekyll Quick-start Guide for more info.

Install Jekyll

$ gem install jekyll bundler
$ bundle install

Install gulp

Jekyll will compile sass out of the box, but we're using gulp so we can add autoprefixer and whatever else we might need later.

$ npm install .
# installs dependencies listed in package.json, including gulp.

Run jekyll

$ bundle exec jekyll serve
# => Now browse to http://localhost:4000

Run gulp

For CSS development, open a new terminal in your project directory and run the following. This will run the gulp watch scripts to compile sass.

$ gulp

Pushing to GitHub and Submitting a Pull Request

After you have made your changes, you will need to push the local files with the changes back to GitHub in order to submit a pull request. Assuming you are still on the "design" branch, you will be pushing your changes from the local "design" branch to the "design" branch of the forked repo at your GitHub account.

$ git add .
$ git commit -m "Your note" 
$ git push origin design

You will then resume the process at step 6 to submit a pull request.

If you plan to continue working locally and submitting pull requests, you may want to add an upstream remote locally that points to DjangoCon U.S., in order to fetch changes.

License

MIT License