Skip to content

Latest commit

 

History

History
125 lines (79 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

125 lines (79 loc) · 3.35 KB
Raw

Contributing Guide

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Getting Started

This repository has two purposes:

  • Maintaining the OST website
  • Storing documentation related to the team goals and strategy

Creating Issue and Pull Request

Submitting changes requires an issue to describe what you want to change and why. Secondly you will need to start a new pull request where your progress is tracked and all discussions related to your implementation is kept.

  • Fork the repository
  • Create an issue
  • Open a pull request and use the label - pr: Work in Progress
  • See below template

Making and Submitting Changes to the Pull Request

As you work through the issue, make sure you commit your changes in logical chunks, include a commit message that describe what you changed and why.

  • Commit with a meaningful message
  • Sign the commit
  • Once the PR is ready, please remove the label - pr: Work in Progress
  • See below template

Example Template for Pull Request

We have included a template on Github for creating new pull requests. An example is shown below to give you an idea of what information we need, to understand your submitted changes. A pull request should:

  • Use a clear title
  • Have a reference to the issue it is fixing
  • Have a description of 2-3 sentences to explain the changes being made
  • Indicate if it's a new feature, bug fix or refactor
  • Outline the tasks being done to solve the issue
Issue #15 - Initial website layout

This PR creates the initial scaffold structure for the team website. The Catwatch data is called via the `fetch` API and
displayed in `index.html` page. CSS Flexbox is used as the CSS layout model.

Types of Changes

What types of changes does your code introduce? Put an `x` in all the boxes that apply and remove the other points which aren't applicable:

- [x] New feature (non-breaking change which adds functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Configuration change
- [ ] Refactor/improvements
- [ ] Documentation / non-code

Tasks:

- [x] Create index.html
- [x] Setup css and js code
- [ ] Follow Zalando dress-code standard

Checklist

Go over all the following points, and put an `x` in all the boxes that apply:

- [ ] My change requires a change to the documentation & I have updated it accordingly.


Screenshot: (optional)

  - Attach a screenshot image file

Example template for commit message

git commit -m "Initial scaffold for the website layout" -s

The -s in the above commit message signs your commit.

Development

To build the documentation locally, you need at least:

$ ruby --version
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux-gnu]

$ bundler --version
Bundler version 2.3.26

Running locally

bundle install --path vendor/bundle
bundle exec jekyll serve

In case the installation fails due to issues with installing eventmachine, set the openssl path explicitly:

bundle config build.eventmachine "--with-ssl-dir=$(brew --prefix [email protected])"

Updating dependencies

bundle update

Optimizing images

find ./assets -iname "*.jpg" -exec jpegoptim -p --strip-com --strip-iptc -m 90 -o -t {} \;

Contact