About the Foundation for Public Code

About the Foundation for Public Code

Contents

  1. Contributing
  2. Preview, build and deploy
  3. License

We help open source projects for public organizations to become successful, build sustainable communities around them and create a thriving public open source ecosystem.

Our mission is:

[…] to enable public-purpose software and policy that is open and collaborative.

The About site is home to all of our staff information, decision-making rules and processes. It is our staff manual that can be developed collaboratively with the community and reused by everyone.

It’s main branch is the official ‘source of truth’ and central repository for all information about the Foundation for Public Code.

pages-build-deployment Test Scheduled link check

Contributing

We are looking for people like you to contribute to this project by suggesting improvements and helping develop the Foundation for Public Code. 😊

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please be lovely to all other community members.

Preview, build and deploy

The repository builds to a static site deployed at about.publiccode.net. It is built with GitHub pages and Jekyll.

Releasing and deploying is done with a release branch.

We aim to deploy every Monday.

You can use the scripts:

  • ./script/serve.sh to serve the site locally with livereload
  • ./script/test.sh to run the tests including markdownlint and htmlproofer

The test.sh script takes the same steps as the continuous integration tests. It is comprised of

  • ./script/test-markdown.sh which uses the mdl linter to detect markdown errors and is yaml “front-matter” aware
  • ./script/test-without-link-check.sh which uses html-proofer to verify correct site construction
  • ./script/check-new-links.sh which extracts new links added by the patch and checks to see if they are valid

If run with ./script/test.sh --all, then it also includes

  • ./script/test-with-link-check.sh which uses html-proofer to verify that all of the external links, even ones not related to the patch, are valid; a failure of this test may not be related to your work

The test-with-link-check.sh helps the maintainers identify links which have gone stale.

License

CC0

To the extent possible under law, the Foundation for Public Code has waived all copyright and related or neighboring rights to the content in this repository. It is licensed CC0, which basically means that anyone can do anything with it. This does not apply to trademarks or logos of the Foundation for Public Code.

Contributors to this repository agree that their contributions also fall under this license and that they have the power and authority to grant this licence.