Add blueprint.
[tails-test.git] / wiki / src / contribute / working_together / criteria_for_easy_tasks.mdwn
blob049acf69365d7f5828bdbaf830962869d59e64ce
1 [[!meta title="Marking a task as easy"]]
3 We think that having issues flagged as "easy" on Redmine is a great tool
4 to help new contributors getting into Tails. Here are a few criteria to
5 help us determine which issues to put in this category.
7 We want to allow people with very different skills to contribute to
8 Tails for the first time. Programmers, web designers, documentation writers, or
9 translators should be able to find tasks that they can complete without
10 having to acquire a deep knowledge of Tails or to learn how to use tools
11 that are outside of their field of expertise.
13 Creating an easy task
14 =====================
16 When creating an easy task, try to write a description that is as helpful as
17 possible to someone who is new to the project:
19   - Describe precisely what to achieve and the skills needed.
20   - Explicitly link to useful resources (eg. code), information (eg. threads),
21     etc.
23 General
24 =======
26 - Not easy:
27   - Has subtasks or is blocked by other issues.
28   - Needs to be split to be actionable.
30 Audit & Research
31 ================
33 - Not easy:
34   - Interacts with several subsystems of Tails.
36 Code
37 ====
39 - Easy:
40   - Write a patch that doesn't need to rebuild Tails.
41 - Not easy:
42   - The first solution that comes to your mind is not the right one.
43   - Interact with several subsystems of Tails.
44   - Rework on a first attempt to code that failed because things were
45     more difficult that they seemed at first glance.
46   - Have specific hardware for the task.
48 Discuss
49 =======
51 - Not applicable.
53 Documentation
54 =============
56 - Easy:
57   - Write user documentation.
58 - Not easy:
59   - Use Git or send patches.
61 Promote
62 =======
64 - Easy:
65   - Explain how to use Tails as described in the documentation.
66 - Not easy:
67   - Explain how Tails work based on the design document.
68   - Speak on behalf of Tails.
70 Sysadmin
71 ========
73 - Not easy:
74   - Have privileges on Tails infrastructure.
75 - Easy:
76   - Work that can be tested locally, for example using a virtual
77     machine.
78   - Work on programs that achieve one-time goals.
79   - Write Puppet patches.
81 Test
82 ====
84 - Easy:
85   - Test behaviour of Tails using the GUI.
86 - Not easy:
87   - Code or build a dedicated testing infrastructure.
89 Translate & Website
90 ===================
92 - Not easy:
93   - Use Git or send patches.
95 Wait & Communicate
96 ==================
98 - Easy:
99   - Send nice emails to ask for updates.