Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 2.52 KB

Contributing to AtB Community

There are many ways to contribute to AtB and AtB's projects. All projects that can be open are by default open, but there are other ways of contributing than just code. See document on how Open Source is organized to get more details.

This document tries to cover different ways to contribute to the project, both technical and non-technical. The goal of this document (and linked documents) is to encourage new and existing contributors and make it as simple as possible to get started or get the answers you need. Another goal is to be as transparent as possible with development.

Contributions are noted as inbound=outbound.

Open Development

All work that can be open is open on the AtB GitHub Organization, but can also be linked from beta.atb.no. Everyone can contribute in different ways (see vocabulary) and all follow the same review process.

When adding Issues or Pull Requests to any of AtB's repositories that information will be open and available for anyone to see. If you have anything that you want to communicate in private, see beta.mittatb.no.

Proposals and RFCs

New proposals of all types (technical, design, user experience) can be made by everyone and follows the structure as specified in the RFC readme.

Review process and Pull Requests

We follow Pull Requests and review process. Changes should not be committed directly to master, but in a separate branch (or fork) and proposed as a change through Github Pull Requests. When adding PRs we require at least one committer (see governance) to approve it.

Read complete specification of workflow and the QA process.

Language

External contributors are free to use English when interacting with projects within the AtB organization, but as general working language we adhere to these principles:

In Norwegian:

  • Issues, Features, and tasks.
  • Comments, QA, code reviews, and suggestions.
  • Roadmap descriptions etc.
  • Release text descriptions.

In English:

  • Code (variables etc) and code comments.
  • Commit messages.
  • Pull Request Titles (will be reused for changelog)
  • Technical documentation (getting started, contribution guide, etc).