canonical / is-charms-contributing-guide

The code contributing guide for the IS charms team
Apache License 2.0
2 stars 1 forks source link

add standard for the programming language to be used #1

Closed jdkandersson closed 2 years ago

jdkandersson commented 2 years ago

Thank you @merkata, I have made some changes to cover:

merkata commented 2 years ago

@jdkandersson thanks for addressing the feedback - looking at the doc with the latest changes, it is clear and concise, very well done. I don't have anything to add at this point, really like it.

mthaddon commented 2 years ago

Here's some proposed wording, based on what we discussed yesterday:

## Programming Languages and Frameworks

We are a team primarily focused on developing charms, and we should follow the
recommended tools and best practices of the ecosystem we work within (and help
to improve them where appropriate). As a result, the primary programming
language we work in is Python, and the primary framework we use to develop
charms with is the [Operator
Framework](https://github.com/canonical/operator).

We will also be working on older charms which may be written in older
frameworks such as the [Reactive
Framework](https://charmsreactive.readthedocs.io/en/latest/). In some cases
we'll work on converting those to the Operator Framework but for small bug
fixes or changes this may not be the case.

As a team we'll also be exposed to a much lesser extent to other programming
languages as a result of working with specific applications that we deploy on
Juju, or via small changes to Juju itself, which is written in Go. We also
encourage exploration and experimentation in a range of programming languages
depending on the interest of the individual as part of using Canonical's
annual training budget.

Let me know if you'd prefer it in a different format, or have any other thoughts on it.

jdkandersson commented 2 years ago

Here's some proposed wording, based on what we discussed yesterday:

## Programming Languages and Frameworks

We are a team primarily focused on developing charms, and we should follow the
recommended tools and best practices of the ecosystem we work within (and help
to improve them where appropriate). As a result, the primary programming
language we work in is Python, and the primary framework we use to develop
charms with is the [Operator
Framework](https://github.com/canonical/operator).

We will also be working on older charms which may be written in older
frameworks such as the [Reactive
Framework](https://charmsreactive.readthedocs.io/en/latest/). In some cases
we'll work on converting those to the Operator Framework but for small bug
fixes or changes this may not be the case.

As a team we'll also be exposed to a much lesser extent to other programming
languages as a result of working with specific applications that we deploy on
Juju, or via small changes to Juju itself, which is written in Go. We also
encourage exploration and experimentation in a range of programming languages
depending on the interest of the individual as part of using Canonical's
annual training budget.

Let me know if you'd prefer it in a different format, or have any other thoughts on it.

Thank you Tom, I have included this and left in the first paragraph explaining the reason for needing the standard. Please let me know if there is any more feedback