Contributing

Contents

1. How to Contribute

2. Guidelines

3. Current Projects

How to Contribute

Thank you for your interest in contributing to the project! There are many ways you can help, whether it's coding, design, 3D modeling, social media, documentation, and more.

The first step is to fork this repository to your own GitHub account. You can then make changes as you see fit. When you're ready, submit a pull request. The team will review your work and either suggest improvements or merge it into the main repository.

Not familiar with GitHub, repositories, or pull requests?

No problem! Many contributors start without prior experience. We're here to help. Follow this guide, and if you have any questions, feel free to message a team member on Discord.

GitHub Guide

1. Create an account on GitHub.

2. Go to the main OpenA3XX community repository.

3. In the top right corner, click the Fork button:

4. This creates a copy of the repository in your account. You can upload, edit, or remove files as needed.

5. When you're ready to submit your changes, click Pull Request:

6. Complete the title and provide a brief description outlining your changes, then click Submit. The team will review and respond.

For a more detailed explanation, see the GitHub Documentation.

Once GitHub is set up, decide how you'd like to contribute. Please check the 'Current Projects' section below to see what's already being worked on and its current status. If you want to help with an existing item, contact the owner for guidance. If you have a new idea, that's great—we welcome your contributions! Be sure to review the 'Guidelines' section for any specific requirements.

It's a good idea to let us and others know what you're working on.
This helps prevent duplicate efforts and gives everyone an overview of ongoing work.

General Guidelines:

• Follow the existing code style and formatting.

• Write clear, concise commit messages.

• Document your changes where necessary.

• Test your contributions before submitting a pull request.

• Be respectful and collaborative in all communications.