Skip to content

Latest commit

 

History

History
134 lines (98 loc) · 6.42 KB

README.md

File metadata and controls

134 lines (98 loc) · 6.42 KB
Raw
Logo

OpenA3xx Community Contributions Documentation

This is the home of the community contributions and documentation for the OpenA3xx project.

About The Community Contributions

This is the single place to keep track of all the community contributions.
You will find the guidelines around contributing and the decisions being made.
It is designed to help organise ongoing projects, and establish who is already doing what, and the progress on that item.
It is designed for collaboration, and edits are welcomed where required. So, please help us make this documentation better.

The idea started in the discord: Community Discord

The discord is a great place to communicate, get help and be sociable. Please stop by and consider joining us!

Contents:

  1. How to contribute
  2. Guidelines
  3. Current Projects
  4. What next?

How To Contribute

Firstly, thanks for taking an interest on the project and wanting to help!
We have many areas where people can offer their help and contribute to the project,
whether it's coding, design, 3D modelling, social media, the list goes on!

The first thing we reccommend doing is to fork this repo to your own github, where you can make
changes as you please. When you're ready, you can then send a pull request where the team will view your work
and either suggest changes/reccommendations, or merge it into the main repo.

But, wait! I don't know anything about GitHub, repos and pull requests?!

Not a problem! Plenty of people will be able to help out on the project and not know a single thing about this.
We're here to help. Follow this guide, and if you have any more questions, feel free to drop a member of the team a message on Discord.

GitHub Guide

Start by creating an account on GitHub
Once logged into your account, goto the main OpenA3xx community repo
In the top right corner of your screen, look for a button that says fork and looks like this:

This will then create a 'working copy' of the directory to your account. You can upload, edit, remove whatever you like as you see fit. When you're happy with your changes/submissions, click Pull Request.

Complete the title and a breif description outlinging your changes/submissions and click submit. The team will then review this and get back to you.

A more detailed explantation can be found here:
GitHub Documentation

Ok, now we've got GitHub setup and running, you decide on how you wish to help out. Please firstly check the 'Current Projects' section below to see if something is already being worked on,
and if so, what stage it is at. If you wish to help out on that item, please contact the owner to seek guidance. If you don't see the item you want to work on, then great! We would love your help!
Check the 'Guidelines' section to check if there are any specific restraints or specifics you should adhere too.
Then, it's all down to you!

It's obviously a great idea to let us and others know what you're working on.
It'll preent you working hard on something at the same time someone else is too!
Also, we'll have an overview of what is currently being worked on, and where the project is at.
So don't forget to add your contribution details to the 'Current Projects' section!

Guidelines

This section explains the style and design guidelines that have been chosen for each area of the project.
Please read this section carefully, to make sure your contributions are in line with everyone elses work!

  • MCDU
    1. Font
      2. We are currently working the 'MS 33558' which can easily be found on Google. This is still an open discussion, as there is a problem working with the font inside Fusion 360 etc. Please monitor this section for regular updates.
    2. Dimensions
      3. TBC
  • FCU
    1. TBC
Pending Items:
1)

Current Projects

This table is to show current projects and their state.
To create an entry, please use this template and edit the relevant text fields:

| project title | Name(Preferably Discord name) | current status | what part is being worked on |

Make sure this is on ONE line (no matter how long it is!) and make sure there is a space between each "|"
Please contact the team if you need any help with this.

Title Owner Stage Currently Working On
The community contribution docs Kavster#4400 Complete index.md page
FCU Panel (Front+Middle+Back) DRIV3R78 In Progress reworking the fonts
MCDU Panel (Front+Back+Inlay) DRIV3R78 Complete
MCDU Button Labels DRIV3R78 In Progress sketching LSK Keys
Korry Button Label Template DRIV3R78 In Progress reworking the fonts
Overhead (FWD) Panels Kavster#4400 In Design VU25 - Lights/Ice