This is the website of the Cross Government Software Enginering Community, aiming to be a place to find information about the group and other useful resources for government software developers.
To get a local copy up and running follow these simple steps.
To develop the website you will need the following.
- npm
npm install npm@latest -g
- Clone the repo
git clone git@github.com:uk-x-gov-software-community/uk-x-gov-software-community.github.io.git - Install NPM packages
npm install - to run the site locally
npx @11ty/eleventy --serve --port=8081
Before running Docker installation please make sure Docker process is running.
- Clone the repo
git clone git@github.com:uk-x-gov-software-community/uk-x-gov-software-community.github.io.git - Build the repository locally.
docker build -t uk-xgov-software-community . - Run the site locally
docker run -dp 127.0.0.1:8081:8081 uk-xgov-software-community
Once you are done with the work with the container, you can stop the Docker container.
- Fetch the docker container ID:
docker container ls | grep "uk-xgov-software-community" - Copy the container ID.
- Stop the container.
docker container kill <CONTAINER_ID>
This stops the container from running and releases all bound ports.
See the open issues for a list of proposed features (and known issues).
We welcome all contributions, suggestions and feedback!
Raise an issue on the GitHub issues board with as much information as possible. Provide use cases and examples if you can. Check there isn't already an open issue for your suggestions first and if there is you can add a +1 and a comment so we know you're interested in it too.
If you've found a bug, check the open issues to see if it's already been reported - if it's not raise an issue and tag it was a bug. Give clear steps to replicate and as much information as you can.
Run the tests where needed, (at this time no functionality is used that requires tests) but ensure you've run them before contributing any code and add tests if you're adding or extending any functionality.
To add changes, make a new branch off main.
If you're not a member of the project, you'll need to fork the project and create a branch on your fork. See full instructions here.
We recommended the following branch naming, for a new feature use feature/add-new-content-<page> and for bug use bug/fix-returning-wrong-status.
We don't squash merge to preserve the history of the work so always write clear log message for your commits. You can squash commits if you feel they could be tidied up. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Here's a handy resource for writing good commit messages and general git housekeeping.
Once you have committed your changes, raise a pull request into main. Add as much information as you can to the pull request, make sure you complete the template and to include the issue number you're changes are addressing.
Before raising a pull request, ensure all tests pass and you have run the linting tools. See the README for instructions on how to do this.
Contact the group via our mailing list for help with this project.
This project follows the alphagov Github organisation's Code of Conduct.