Skip to content

Commit 34d166b

Browse files
authored
Merge pull request #454 from zalando/clean-up
Clean up OSS guidelines
2 parents ca22fd9 + d0d5a34 commit 34d166b

33 files changed

+197
-1636
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
11
## Task Headline
22

33
Issue description and motivation (what and a why).
4-
5-
### Tasks
6-
7-
These are the concrete tasks to complete before the issue is marked as done:
8-
9-
- [ ] task 1
10-
- [ ] task 2
11-
12-
### Expected delivery
13-
14-
What is the concrete outcome of this work:
15-
16-
17-
## Stakeholders
18-
19-
Who do we need to align with to make this happen? Add the department to get in touch with.
20-
21-
- [ ] Department name
22-
23-
24-
## How do we measure the task was completed
25-
26-
How do we measure impact:
27-
28-
1.
29-
1.
30-
1.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
1-
Issue: #
2-
31
## Description
42

53
Describe the motivation and context for the proposed change.
6-
7-
## Types of Changes
8-
9-
_What types of changes does your code introduce? Remove the points which aren't applicable:_
10-
11-
- New feature (non-breaking change which adds functionality)
12-
- Bug fix (non-breaking change which fixes an issue)
13-
- Configuration change
14-
- Refactoring/improvements
15-
16-
## Tasks
17-
18-
- [x] Created Task 1
19-
- [x] Created Task 2
20-
- [ ] To-do Task 3
21-
22-
## Checklist
23-
24-
_Go over all the following points, and put an `x` in all the boxes that apply:_
25-
26-
- [ ] My change requires a change to the documentation and I have updated it accordingly.
27-
28-
## Screenshots/Videos (OPTIONAL)
29-
30-
Here's a sample PR template: [link](../../master/CONTRIBUTING.md#example-template-for-pull-request)

CONTRIBUTING.md

Lines changed: 1 addition & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -2,86 +2,6 @@
22

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

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-
855
# Development
866

877
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 -
12242
# Contact
12343

12444
- **Email**: opensource@zalando.de
125-
- **Issue tracker**: https://github.com/zalando/ost/issues
45+
- **Issue tracker**: https://github.com/zalando/zalando.github.io/issues

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Zalando SE
3+
Copyright (c) 2018-2025 Zalando SE
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,12 @@
1-
# Zalando Open Source Team
1+
# Zalando Open Source
22

3-
The repository of the Zalando Open Source Team (Contact: opensource@zalando.de). Includes the team website and issue tracker with the tasks we are currently working on.
4-
5-
6-
## The purpose of the open source team
7-
The Zalando Open Source Team is responsible for nurturing and growing Open Source and open practices at Zalando.
8-
We work across departments as internal consultants to remove barriers for contributing, producing and consuming Open
9-
Source code.
10-
11-
We advise and assist on:
12-
13-
- Creating and nurturing Open Source communities around Zalando Open Source projects
14-
- Align community interests with Zalando business interests
15-
- Efficient and compliant adoption of Open Source code by Zalando teams
16-
- Recruiting from Open Source communities
17-
- Best practices for applying open source to internal projects
18-
19-
We are also here to demystify and simply answer questions, so no matter if you are working at Zalando or not, get in touch: opensource@zalando.de
20-
21-
## Purpose of this repository
22-
This repository primary serves as the public website, issue tracker and history of the Open Source Team. We do however plan to share additional resources and tooling in the future via this repository.
23-
24-
## Have a look at what we are working on
25-
26-
- Our project backlog is public, and can be found under the [projects page](https://github.com/zalando/ost/projects/1)
27-
- The Issue tracker is also open to view and add issues to [Issue tracker](https://github.com/zalando/ost/issues)
28-
29-
If you have general questions around Open Source @ zalando, the quickest way to get in touch is via email: opensource@zalando.de.
3+
This repository contains the source code of our website showcasing Open Source at Zalando: https://opensource.zalando.com
4+
In addition, it includes guidelines that companies willing to adopt Open Source can use as a baseline.
305

316
## Contributing
327

338
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
349

3510
## License
3611

37-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
12+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

_docs/index.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,22 @@ banner:
88
image: laptop.jpg
99
---
1010

11-
#### Despite widespread use, there are still many misconceptions and uncertainties for Zalando employees engaging in Open Source. Questions on legal issues, licensing and what is deemed confidential or internal information is common.
11+
#### Note: this page used to host Open Source guidelines for Zalando employees. In 2022, the page has been moved to an internal documentation site, discoverable in Zalando developer portal (Sunrise) and other internal channels using the keyword "opensource".
1212

13-
This website is therefore a guide, primarily for Zalando employees, on how to adopt, modify and release Open Source code. There are a few references to internal Zalando sites or services, but with an effort to limit our use of internal lingo or acronyms.
13+
After moving these guidelines to an internal site, we extended them as follows:
1414

15-
#### Topics
16-
- [Open Source Licensing Guide]({{"docs/resources/licensing" | relative_url }})
17-
Policies and guidance on which licenses can be used internally at Zalando and in Zalando open source projects
15+
1. Replaced Google Forms with GitHub Issues to track requests for releasing new Open Source projects and allow-listing end-user licenses and CLAs (Contributor License Agreements).
16+
2. Extended the list of allowed CLAs with approval dates and notes from the legal team.
17+
3. Added a list of *Formerly Open Source Projects*, such as Akka, Redis, Terraform, together with legal considerations for the licenses these projects migrated to and with recommended Open Source alternatives.
18+
4. Split release guidelines into two separate guides: *Guide for maintainers* who would like to release a new project and a *Guide for leads* who are asked for approval of open-sourcing a project.
19+
5. Moved away from a strict incubation and graduation processes to a more flexible approach. Projects are now open-sourced continuously or archived after a long period of inactivity.
1820

19-
- [Adopting open source code]({{"docs/using/index" | relative_url }})
20-
Policies on what to be aware of when adopting open source code in a Zalando project. This applies to both adding dependencies and to contributing upstream.
21+
### Archived OSS guidelines
22+
To view the archived content, check the [source code history](https://github.com/zalando/zalando.github.io/tree/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs) on GitHub. The material includes:
2123

22-
- [Releasing an open source project]({{"docs/releasing/index" | relative_url }})
23-
A step by step guide on what to do before you can release a project and guidelines on how to
24-
maintain a project
25-
26-
- [State of open source at Zalando 2018 Report]({{ "docs/reports/2019/january-2019" | relative_url}})
27-
The 2018 report on how open source is doing at Zalando with key numbers and insights, as well as a roadmap forward
28-
29-
- [Anti-Harassment Policy]({{"docs/resources/harassment-policy" | relative_url }})
30-
Policy on how we manage online harassment and support our maintainers and contributors as when working with open source as part of their work at Zalando.
24+
- [Anti-harassment policy](https://github.com/zalando/zalando.github.io/blob/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs/resources/harassment-policy.md)
25+
- [Releasing a new project](https://github.com/zalando/zalando.github.io/blob/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs/releasing/index.md)
26+
- [Release sign-off guide for leads](https://github.com/zalando/zalando.github.io/blob/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs/releasing/lead-sign-off-guide.md)
27+
- [OSS licensing guide](https://github.com/zalando/zalando.github.io/blob/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs/resources/licensing.md)
28+
- [Contributing upstream](https://github.com/zalando/zalando.github.io/blob/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs/using/contributing.md)
29+
- [Employee copyright](https://github.com/zalando/zalando.github.io/blob/ca22fd9dfa96f6a25a6a5ea8b94c9ad815461cb4/_docs/using/employee-copyright.md)

_docs/promoting/organize-release-party.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)