|
2 | 2 |
|
3 | 3 | 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 |
4 | 4 |
|
5 | | -# Getting Started |
6 | | - |
7 | | -This repository has two purposes: |
8 | | -- Maintaining the OST website |
9 | | -- Storing documentation related to the team goals and strategy |
10 | | - |
11 | | -## Creating Issue and Pull Request |
12 | | - |
13 | | -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. |
14 | | - |
15 | | -- Fork the repository |
16 | | -- Create an issue |
17 | | -- Open a pull request and use the label - `pr: Work in Progress` |
18 | | -- See below [template](#example-template-for-pr) |
19 | | - |
20 | | - |
21 | | -## Making and Submitting Changes to the Pull Request |
22 | | - |
23 | | -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. |
24 | | - |
25 | | -- Commit with a meaningful message |
26 | | -- Sign the commit |
27 | | -- Once the PR is ready, please remove the label - `pr: Work in Progress` |
28 | | -- See below [template](#example-template-for-commit-message) |
29 | | - |
30 | | - |
31 | | -### Example Template for Pull Request |
32 | | - |
33 | | -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: |
34 | | - |
35 | | -- Use a clear title |
36 | | -- Have a reference to the issue it is fixing |
37 | | -- Have a description of 2-3 sentences to explain the changes being made |
38 | | -- Indicate if it's a new feature, bug fix or refactor |
39 | | -- Outline the tasks being done to solve the issue |
40 | | - |
41 | | -``` |
42 | | -Issue #15 - Initial website layout |
43 | | -
|
44 | | -This PR creates the initial scaffold structure for the team website. The Catwatch data is called via the `fetch` API and |
45 | | -displayed in `index.html` page. CSS Flexbox is used as the CSS layout model. |
46 | | -
|
47 | | -Types of Changes |
48 | | -
|
49 | | -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: |
50 | | -
|
51 | | -- [x] New feature (non-breaking change which adds functionality) |
52 | | -- [ ] Bug fix (non-breaking change which fixes an issue) |
53 | | -- [ ] Configuration change |
54 | | -- [ ] Refactor/improvements |
55 | | -- [ ] Documentation / non-code |
56 | | -
|
57 | | -Tasks: |
58 | | -
|
59 | | -- [x] Create index.html |
60 | | -- [x] Setup css and js code |
61 | | -- [ ] Follow Zalando dress-code standard |
62 | | -
|
63 | | -Checklist |
64 | | -
|
65 | | -Go over all the following points, and put an `x` in all the boxes that apply: |
66 | | -
|
67 | | -- [ ] My change requires a change to the documentation & I have updated it accordingly. |
68 | | -
|
69 | | -
|
70 | | -Screenshot: (optional) |
71 | | -
|
72 | | - - Attach a screenshot image file |
73 | | -``` |
74 | | - |
75 | | - |
76 | | -### Example template for commit message |
77 | | - |
78 | | -``` |
79 | | -git commit -m "Initial scaffold for the website layout" -s |
80 | | -``` |
81 | | - |
82 | | -The `-s` in the above commit message signs your commit. |
83 | | - |
84 | | - |
85 | 5 | # Development |
86 | 6 |
|
87 | 7 | To build the documentation locally, you need at least: |
@@ -122,4 +42,4 @@ find ./assets -iname "*.jpg" -exec jpegoptim -p --strip-com --strip-iptc -m 90 - |
122 | 42 | # Contact |
123 | 43 |
|
124 | 44 | - **Email**: opensource@zalando.de |
125 | | -- **Issue tracker**: https://github.com/zalando/ost/issues |
| 45 | +- **Issue tracker**: https://github.com/zalando/zalando.github.io/issues |
0 commit comments