Here you can see a brief explanation of what you can find in each folder in our GitHub repository.
We welcome any additions to documents in our repository or any amendments or improvements to already existing work.
Here you will find all the work that has been carried out on the Moderation workstream of the project.
Moderation looks into how we can keep the platform safe and appropriate for public viewers. This includes decisions on:
- What is an appropriate or inappropriate story
- How the platform will facilitate moderating stories
- Who will moderate stories and what the process is
- Define the escalation route if moderators are unsure
- Define the interaction between users and moderators
This folder includes key information about the project as well as resources (papers and websites) to provide you with a full and wider picture of the project scope and it's aims.
This folder includes all information on how we will ensure our platform and project has accessibility at the forefront of plans, tasks and actions.
A key piece of work in this is the accessibility checklist which follows the requirements from gov.uk on how to ensure a website is accessible to all.
Here you will find applications that are associated with the project.
This includes:
- Applications to internships with the project such as GSoC (Google Summer of Code).
- Applications to spread the word of the project to large events such as CC Global Summit.
In this folder you will find key tools on building a healthy community. This includes tools to not only outreach to potential volunteers but also tools to ensure that contributors are getting what they want and need from the project.
There are also tools to portray our community so that we understand the platform which AutSPACEs project in built upon. The understanding of the types of contributors that we have on the project helps plan tasks and events.
Here you will find recommendations, ideas, and prespectives from members of the AutSPACEs community.
Their contributions guide all the work that we do for the project. Many of these contributions are relevant to earlier phases of the project, while others relate to present and future work.
In this folder you will find broader understanding of where you can get involved in the project and it's different areas.
This includes:
- Design
- Strategy
- Communications
- Ideas
- Networks
- Code
- Legal Advice
This is where we keep all images that we have in our repository.
This includes a link to our second repository where we keep specifically our code for the platform development.
Any other, documents that aren't specifically related to code need to be kept in our first repository.
This is a folder where we keep all the designs for the AutSPACEs project.
This includes our wireframes which is what the coding has been based off as well as a written out requirements lists of what needs to be seen on each page. A user flow here also shows how the different pages interact with each other.
You can also find some helpful technical information on how to develop the platform.
Here is where we keep all our communications for the project.
This includes all our past newsletters and presentations. It also includes our communications for various events such as our community meet-ups.
This folder contains information about the project which may be useful to collaborators wanting a more detailed overview.
This is where you can find information about how we manage the project from a strategic perspective. It includes our fortnightly progress updates which we share at our community calls. Minutes from key strategic meetings are also logged here.
Our roadmap is a really good document to understand where we are with the project and what tasks need to be done.
This folder is to collect information and connections to key research and projects that fit in with the wider research scope of the AutSPACEs project.
Steps to contribute:
- Go to our respository.
- Find our list of issues.
- Find an issue that you find interesting.
- If it has already been assigned - comment on the issue tagging @lottycoupat and the assignee to ask if there is anywhere you can help.
- If the issue is not assigned - comment on the issues asking to be assigned, tagging @lottycoupat.
- @lottycoupat will then get in contact with you to briefly discuss your contributions and ensure you are confident to contribute.
Once you have created a contribution you can either:
- Create a Pull Request to merge your work with the master repository (see pull request below).
- Send over your documents to Lotty who will review and upload your contributions on your behalf.
Our list of issues can be found here for the wider project and here specifically for issues on platform coding and development.
The issues here relate to the wider project.
Each issue will be tagged with the area that it relates to in the project.
The issues here relate specifically to platform coding and development.
Each issue will be tagged with the milestone that it relates to. You can find a breakdown and explanation of each milestone here.
If you want to make changes or add content to our repository in GitHub, you will see that you have to save the work to a branch. This is because we need to review the additions before
Once you have created a contribution in a branch, the best way to get this merged into our documentation is to make a pull request.
A pull request will let us know about the changes you want to make to the GitHub repository. Once a pull request is sent, members of the project team can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
If you would like to know more about GitHub, the Turing Way has a great guide on how to use it's features and why it is a great resource for Open Source projects. You can find the guides here.