Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.9 KB

Contributing to TruBudget

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to Jure Zakotnik, who is the current project maintainer.

Support

We use issues for everything, so can can ask questions as well as raise problems or suggestions by simply creating a GitHub issue. Also, feel free to reach out to us on Gitter.

Architecture Decisions

When we make a significant decision in how to write code, or how to maintain the project and what we can or cannot support, we will document it using Architecture Decision Records (ADR). Take a look at the doc/architecture/decisions directory for existings ADRs. If you have a question around how we do things, check to see if it is documented there. If it is not documented there, please ask us - chances are you're not the only one wondering. Of course, also feel free to challenge the decisions by starting a discussion on Gitter or by opening a new GitHub issue.

Source Layout

Best practices and layout is documented in README files next to the source files they describe. For example, take a look at api/src/ to get started.