Skip to content

Latest commit

 

History

History
307 lines (238 loc) · 25.2 KB

README.md

File metadata and controls

307 lines (238 loc) · 25.2 KB
Raw

2023.djangocon.us

Contributors

The 2023 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.

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.

  4. Within your forked repo, make sure the "Branch" tab is set to the main branch.

  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. If you are not ready for your pull request to be immediately merged, you can let those reviewing pull requests know by using the acronym WIP (Work in Progress) or a similar message in your pull request title.

Example: Updating Organizer Info

Follow the above instructions to step 5.

Click on the _organizer folder, then your own MY_NAME.md file. Click on the pencil icon to open the file. Make your changes, making sure that your information is placed within quotation marks.

To add a photo: navigate to the static/img/organizers folder. Click "Upload files". Drag or choose your photo file into the window. Click "Commit changes". Your photo should now be in the folder. Ideally, the photo should be 400 x 400px. In your MY_NAME.md file, make sure the path to your photo has the proper name and file ending (.jpg, .png, etc.).

If you need assistance, please ask! Complete step 6.

Contributing via Local Development

For changes that require cloning/running the code locally, follow the above 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 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).

$ git clone https://github.com/<your-username>/2023.djangocon.us

Change directory into the folder

$ cd 2023.djangocon.us

Verify that you are on the main branch

$ git branch

Follow the instructions below to run the website on a local server.

Prerequisites

Install Jekyll

GitHub recommends using Bundler to install and run Jekyll.

You might need to use $ sudo gem install jekyll bundler foreman

$ gem install jekyll bundler
$ bundle install

Install Node Dependencies

You'll need to install all the JS dependencies.

$ npm install .
# installs dependencies listed in package.json

Compile CSS & JS

We're using Webpack to compile Scss and JavaScript.

$ npm run build
# Builds production-ready assets

Run Jekyll

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

Run html-proofer to find broken links and accessibility issues

$ bundle exec rake test

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 main branch, you will be pushing your changes from the local main branch to the main branch of the forked repo at your GitHub account.

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

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 the DjangoCon US repo, in order to fetch changes. You may also want to consider creating a feature branch (also known as a "topic" branch), making your changes there (instead of in the main branch), pushing to GitHub and submitting the update via pull request. You can then keep your main branch up-to-date while working on multiple features.

Contributing via Docker and Docker Compose

If you want to use Docker and Docker Compose to run a web server locally please follow the below steps.

If Docker and Docker Compose are not installed on your system please install them by following the above links.

Once both are installed you can type the following command on the project root directory.

$ docker compose up

If everything works then a local server is available at http://0.0.0.0:4000.

If you want to shutdown your local server you can anytime press ctrl-c to stop the local server from the command line from which you have started the local server.

Adding Contributors

If you have gone through the previous installation steps, the all-contributors-cli package should already be installed locally by npm. The developer dependency and scripts can be found in package.json and the init config and JSON entries in the .all-contributorsrc file.

To add a contributor by GitHub username (this will add a JSON entry to .all-contributorsrc and add the contributor to the README list), run the following command, hitting enter twice to avoid choosing any contribution type

$ npm run add -- <username>
hit enter twice

To generate a README list from the .all-contributorsrc file

$ npm run generate

Contributors

Thanks goes to these wonderful people:

This project uses the all-contributors-cli. Contributions of any kind welcome!

License

MIT License