Skip to content

Coding in the open updates#308

Open
gyro2009 wants to merge 20 commits intomainfrom
gyro2009/codingInOpen
Open

Coding in the open updates#308
gyro2009 wants to merge 20 commits intomainfrom
gyro2009/codingInOpen

Conversation

@gyro2009
Copy link
Copy Markdown
Contributor

@gyro2009 gyro2009 commented Sep 2, 2025

No description provided.

@snyk-io-eu
Copy link
Copy Markdown

snyk-io-eu Bot commented Sep 2, 2025

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@rockydevnet
Copy link
Copy Markdown
Contributor

It maybe worth updating the open source governance check list (and/or referencing it somewhere in these docs):

Comment thread using-github/coding-in-the-open.md Outdated
Comment thread using-github/coding-in-the-open.md
Comment thread using-github/readme.md Outdated
@rockydevnet
Copy link
Copy Markdown
Contributor

The Source Control Policy should also probably be updated to clearly indicate open by default, and provide links to the other relevant policy and guidance?

Comment thread using-github/coding-in-the-open.md
@gyro2009 gyro2009 marked this pull request as ready for review October 22, 2025 10:35
Copy link
Copy Markdown
Contributor

@nevillejrbrown nevillejrbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a few bits of feedback...

Comment thread using-github/software-licensing-policy.md Outdated
Comment thread using-github/software-licensing-policy.md Outdated
Comment thread using-github/code-copyright-policy.md Outdated

## Overview

When developing software for government use, it's important to choose appropriate open source licenses that align with the UK Government's Open Source Policy and the Open Government License framework.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page needs to give advice on what license we should use if it's not being open sourced. I think the answer is don't give it any license, but I think this needs to be spelled out here somewhere.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would always advise adding a license to your repository no matter where your coding just to give you that flexibility if you need to change the visibility. I will add something in :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But what if you specifically don't want to license it? This is possible, e.g. in the case of commercially sensitive contend. We need to keep that option open I think.

Comment thread using-github/coding-in-the-open.md Outdated
Comment thread using-github/coding-in-the-open.md Outdated
Copy link
Copy Markdown
Contributor

@nevillejrbrown nevillejrbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the changes :-)

Copy link
Copy Markdown
Contributor

@nevillejrbrown nevillejrbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I think we need to resolve the licensing conversation. Do you want to discuss on a call?

@gyro2009 gyro2009 requested a review from nevillejrbrown March 12, 2026 16:18
4. Publish the repository and continue development in the open

Because of the reputational, security and business risks (detailed below) that can occur as a result of any contribution to the OS community, all releases must adhere to policies laid out below
If a team believes their code **cannot** be made open, they must provide a documented rationale with a specific reason from the approved list (see [Coding in the Open – Closed code](../../using-github/coding-in-the-open.md)) and record the expected date for opening. This must be reviewed at each service assessment.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this for new code only, or does this apply to legacy codebases?

## Ownership of Open Source repositories
- Ensure that the open source project is governed by an OSI-approved license.
- Verify that the license allows for the intended use and contribution.
- Obtain necessary approvals from the UKHO Legal Advisor for any contributions that may involve valuable intellectual property (CLA for example).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"UKHO Legal Advisor": Does such a person exist?

### 5. Secure Approval for Contributions

### Reputation
- Obtain authorization from the Technology Head of Division before contributing to any open source repository.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems a bit senior for this. This is a relic of a previous HoD who was very nervous about this. Perhaps could be Head of Engineering...?

- **SECRET or TOP SECRET content (MOD-specific)** – code that directly relates to classified systems or content at these markings must not be published
- **Third-party intellectual property not licensed for open publication** – code, algorithms, or data owned by a vendor or third party where the licence does not permit open redistribution

> **Note on "commercially sensitive" code:** Commercial sensitivity alone is **not** a valid reason under GDS or MOD guidance to keep code closed. If a team believes code is commercially sensitive, this must be assessed case-by-case with the product owner, security champion, and legal adviser. A clear and documented rationale must be provided — see [Providing a rationale for closed code](#providing-a-rationale-for-closed-code) below.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Note on "commercially sensitive" code: Commercial sensitivity alone is not a valid reason under GDS or MOD guidance to keep code closed."

I don't think this statement is relevant. Isn't that just because these organisations don't think about commercial concerns? Surely commercial sensitivity is a concern for UKHO...?

- identify the specific subset of code that must remain closed (do not close entire repositories unnecessarily)
- name the applicable reason from the list above
- state the expected date or condition under which the code can be opened
- be recorded in the repository's README or a linked document, and reviewed at each service assessment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't do service assessments. This is a GDS thing.

* [OpenGovernment](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md)
* [Rails](https://github.com/rails/rails/blob/master/CONTRIBUTING.md)
* [GitLab](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md)
# The Importance of CONTRIBUTING.md in Open Source Projects
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we give guidance anywhere about when to accept contributions? In some (a majority of?) cases, external contribution would be unwelcome.

If we do accept contributions (and have an CONTRIBUTING.md), what is the guidance about managing this work, bearing in mind all the teams manage most of their work on AzDo and (I think) don't typically process GitHub issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants