Skip to main content

Contributing Guide

What we are looking for in our Contributors.

Firstly, we at Armada-Alliance would like to thank you for your consideration in contributing to us! We can't wait to hear your ideas and experiences. However, we do have some guidelines that we all must be familiar with and adhere to before submitting your contributions.

Table of Contents​

  1. What we are looking for
  2. Rules and Expectations
  3. How to contribute
  4. Style Guide
  5. Community

What we are looking for

We appreciate all contributions but we do have aspects of the project that take priority.

  • Find and fix inconsistencies and errors in guides
  • Translating the guides into different languages
  • Help explain guides to others from different various backgrounds and knowledge levels

Rules and Expectations

As an open-source project we expect a certain standard from you:

  • Be respectful and open-minded to others' opinions and conversations around this project. Understand that as a community we should all be working together. Take into consideration the way in which another contributor is helping may be different from your own and that it is more productive to help each other out rather than argue about which way is "correct".
  • Armada-Alliance's tutorials are released with a Contributors Code of Conduct. Through partaking in this project you agreed to abide by these terms.
  • If you open a pull request, please make sure that your contribution passes all tests, as failures will sunder the project and a fix must be made.
  • Content that is to be added should be relevant to the project and not include self-promotion or the promotion of sponsors. Understand that what is submitted here will be considered open source and will be shared freely amongst everyone.

How to contribute

First, thoroughly read through the project and consider what level of contribution yours will be.

  • For a minor contribution, such as grammar, open a pull request.
  • For a major contribution, such as a new tutorial, start by ordering an issue first. This way the community can assess and discuss your idea before you start working on it.

Style Guide

If you are contributing tutorials or guides please check out our Style Guide so that it blends into the project seamlessly.

Community

Discussions about the Open Source Guides take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everyone can benefit and learn from the conversation.

Attribution

This contributing guide is adapted from the open-source guide.