Skip to content

Commit 76ac672

Browse files
authored
Merge pull request #108 from degville/readme-cla
README.md updates, including CLA and timing details
2 parents a63f289 + dd68f3d commit 76ac672

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,34 @@ The first words of an issue's title will typically indicate the project it invol
3838

3939
This list will expand as more projects get involved. We're also happy to include projects outside of Canonical.
4040

41+
### Contributor licence agreement
42+
43+
Many of the projects that participate in the Open Documentation Academy require that a contributor has signed a _Contributor licence agreement_, or CLA. Such an agreement will typically grant permission for the project to use a contribution while the contributor retains the copyright and the rights to modify their own work, or use it in other projects.
44+
45+
The [Canonical contributor licence agreement](https://ubuntu.com/legal/contributors) is one such CLA. This [needs to be signed](https://ubuntu.com/legal/contributors/agreement) before a contribution can be considered for inclusion within one of Canonical's projects. Many GitHub repositories for Canonical projects will automatically check whether a contributor has signed the CLA when a contribution is made.
46+
47+
The `cla` issue label is used to help identify which tasks require a contributor to have signed a CLA.
48+
49+
### Time considerations
50+
51+
We’re completely flexible when it comes to how much time a task may take a contributor. Take as little or as much time as you need.
52+
53+
However, we do ask that potential contributors indicate an estimated target date. This helps us to better manage the task list and to ensure tasks are being actively worked on. If you need to change your estimate, please let us know because it won’t be a problem. Similarly, let us know if you are unable to work on a task for a period of time. A comment attached to the task is enough.
54+
55+
If there has been no activity on a task for several weeks, we'll initially reach out to the assignee before releasing the task back into the pool of unassigned tasks.
56+
4157
### Issue labels
4258

4359
We use one or more of the following issue labels both for consistency and to indicate what might be expected from a task.
4460

61+
#### cla
62+
63+
Identifies tasks that require a contributor to have signed a [CLA](#contributor-licence-agreement).
64+
65+
#### code
66+
67+
Used for tasks that may require some programming knowledge, or a programmatic solution.
68+
4569
#### diátaxis
4670

4771
Revise a document to better conform to a [Diátaxis](https://diataxis.fr/) type:
@@ -93,6 +117,10 @@ Review pre-existing documentation for quality, accuracy and consistency. This wo
93117

94118
This is our estimation of effort and complexity. Size values range from 1 to 8, representing _least effort_ to _most effort_ respectively. These numbers follow the [Fibonacci ### sequence](https://en.wikipedia.org/wiki/Fibonacci_sequence) sequence of 1, 2, 3, 5, 8, with size 8 likely to be a significant undertaking.
95119

120+
#### ta wanted
121+
122+
The technical author (TA) team at Canonical wants to help projects without access to documentation experts. This label is used for such projects to mark tasks any technical author can help with.
123+
96124
#### tutorial
97125

98126
Develop, write, edit or update a [tutorial](https://diataxis.fr/tutorials/). Tutorials are often the hardest kinds of documentation to write or update because they primarily require good teaching skills and perception, before you even start writing.

0 commit comments

Comments
 (0)