Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

55 lines (30 loc) · 2.46 KB
Raw

How to contribute

This repo is a reference and learning resource and everyone is invited to contribute, however not all PRs will be accepted into the main branch (main).

There's a general development strategy that's driven by @edmondshtogu, which chooses, or defines criteria for choosing, the issues to include in the codebase, given a bunch of constraints and other guidelines.

Coding Standards

There are no explicit coding standards so pay attention to the general coding style, that's (mostly) used everywhere.

However, there's only one REALLY important rule: use spaces for indenting 😉.

Development Process

In order to help manage community contributions and avoid conflicts, create an issue here, to track assignments to any significant development effort.

Great but... what's "significant"?

That's not too easy to define and there are no clear criteria right now but, probably, changing "a couple" lines of code in one file would not qualify while changing "a bunch" of files would.

We'll all be learning in the process, so we'll figure it out somehow.

General Steps

  1. Issues are managed as usual with the regular issues list, just like any other repo.

  2. Once an issue is marked as a bug, enhancement, new feature or whatever needs development work, it will be labeled as a backlog-item and included as the last item in the Backlog project column.

  3. Community members can propose themselves to code an issue.

Tests

There's not a tests policy in the project at this moment, but it'll be greatly appreciated if you include them.

Forks and Branches

All contributions must be submitted as a Pull Request (PR), so you need to fork this repo on your GitHub account.

The main branch is main:

  • main: Contains the latest code, and it is the branch actively developed.
    All PRs must be against main branch to be considered.
  • Any other branch is considered temporary and could be deleted at any time. Do not submit any PR to them!

Suggestions

We hope this helps us all to work better and avoid some of the problems/frustrations of working in community.

We'd also appreciate any comments or ideas to improve this.

Contributing guide

In order to start contributing please check the guide here.