Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

92 lines (56 loc) · 3.65 KB

Contributing to QuaCo

Hi there, you made the right choose contributing to QuaCo! 🎉👍

The following is a set of guidelines for contributing to this project.

Table Of Contents

Code of Conduct

I don't want to read this whole thing, I just have a question!!!

What should I know before I get started?

How Can I Contribute?

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

I don't want to read this whole thing I just have a question

Join us on discord and have a chat

What should I know before I get started?

Before you start contributing its important to read the software design description. This document will give you a brief explaination about important development aspects like:

  • Deployment
  • Routing
  • Bootstrapping
  • Modules
  • XML based GUI

How Can I Contribute?

Contributing can be done in a lot of ways since this project has just been started. You can have a look at our issue board, but we prefer that you continue to read this section before you do so.

Currently there arent much open issues, because maintaining them takes a lot of time. If you have any experience on one of these fields then please join us on discord. We can have a chat and see what you like to do.

We need:

  • Open source management experience
  • Experienced PHP developers
  • Experienced Front-end developers
  • Database experts
  • UI designers
  • UML masters
  • JS/CSS3 animators
  • SEO oracles
  • Investors

If you truely feel like this is a project in which you would like to invest a longterm relationship with then you can be part of the core development group 🙇 👰‍♀️ 🙇

Your First Code Contribution

Unsure where to begin contributing to QuaCo? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Contributing works in these 6 steps:

  1. Fork
  2. Clone
  3. Work your issue out
  4. Commit this is what your messasage should look like
  5. Push to origin
  6. Create a pull request

Detailed explaination for step 1 - 5 Detailed explaination for step 6

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title

Read code related styling in the 'software design desription'