Skip to content

SETUP.md

Latest commit

 

History

History
68 lines (53 loc) · 3.09 KB

SETUP.md

File metadata and controls

68 lines (53 loc) · 3.09 KB
Raw

EnergyNet GitHub Organization Setup

Maintainer checklist. Do not add confidential information, personal data, secrets, credentials, or internal links to this file.

Publish the organization profile

  • Confirm or create the GitHub organization account and its public URL.
  • Create a public repository named .github in the EnergyNet organization.
  • Publish the contents of this local repository to the public .github repository.
  • Confirm that profile/README.md appears on the organization overview page.
  • Publish the supplied approved official English-language EnergyNet logo files from profile/assets/ without alteration.
  • Verify that the logo files used in profile/README.md are the approved source files.

Organization settings

  • Set the organization display name to EnergyNet.
  • Set the organization description to Expertise and analysis for distributed, intelligent, and flexible energy systems.
  • Set the official website to https://energynet.ru/.
  • Add an approved public contact email on the @ioen.ru domain once confirmed.
  • Add a backlink from https://energynet.ru/ to the official GitHub organization profile after its public URL is confirmed.
  • Add at least two organization owners.
  • Require two-factor authentication for organization members.
  • Review organization member visibility settings.
  • Configure appropriate organization and repository permissions.
  • Pin key publication repositories after reports are released.

.github repository controls

  • Protect the default branch of the .github repository.
  • Require pull-request review for public profile changes.
  • Limit direct pushes to the default branch.
  • Confirm that the repository is public and GitHub Pages is not enabled.

Checklist for every report repository

  • Add README.md.
  • Add the report text in Markdown.
  • Add formatted PDF files.
  • Add English, Russian, and Simplified Chinese versions where available.
  • Add LICENSE.
  • Add THIRD_PARTY_NOTICES.md when third-party content is used.
  • Add a bibliography or source references.
  • State the version number.
  • State the publication date.
  • Add language navigation.
  • Add citation information.
  • State clearly which materials are covered by the repository license.

Rights review before applying CC BY 4.0

Apply Creative Commons Attribution 4.0 International only after confirming that EnergyNet has the necessary rights to the relevant:

  • texts;
  • translations;
  • illustrations;
  • charts;
  • tables;
  • photographs;
  • datasets.

Document any exclusions, third-party rights, and separate licensing terms in the relevant repository. Do not assume that a repository license covers third-party materials.

Information still to confirm

  • The available GitHub organization account name and final public profile URL.
  • The approved public contact email on the @ioen.ru domain.
  • Final confirmation that both supplied logo variants are approved source files for public use.
  • The organization owners, member visibility policy, and repository permission model.