1- Contribute to XXXXXX project
1+ Contribute to XXXXXXX project
22===============================
33
44There are six main ways to contribute to this project. The first one
@@ -55,7 +55,7 @@ When you run the tests you can see the results and errors generated
5555both in the screen and in a file generated in the tests directory.
5656
5757To report a bug please visit the project page at github
58- (https://github.com/i02sopop/XXXXXX ), click on the Issues section and
58+ (https://github.com/i02sopop/snag ), click on the Issues section and
5959add a new issue. Please, be as descriptive as possible with all the
6060information you can and add an email address to contact with you if
6161needed.
@@ -76,36 +76,65 @@ proposal and we find the way to make the donation.
7676 Translators
7777=============
7878
79- TODO
79+ The original language of the project is english, and it have a
80+ translation into spanish. The translations are managed with gettext,
81+ so if you want to enhace a translation or add a new one you should
82+ check the po subdirectory. In that directory you can find one po file
83+ per language, so you can edit the file for the language you'ree interested
84+ in and make the needed changes.
85+
86+ If you want to start a translation to a new language you can copy one
87+ of the po files (the language you're translating from) to a new po file
88+ and start the translation.
89+
90+ For small changes you can do directly a PR with your changes, but if you
91+ want to do deeper changes it's better to add a new task to github and
92+ asign it to you.
93+
94+ For now we have not consider the case of having several people that want to
95+ do a translation to the same language, but if we reach that case we will
96+ design one lead translator (to decide between all) to coordinate the work.
8097
8198 Documenters
8299=============
83100
84- TODO
101+ Documentation, both technical and user oriented, is a really important part
102+ of the project. Apart from the documentation at the code, we have documentation
103+ both in the docs subdirectory and in the github wiki, so feel free to contribute
104+ to any of the places.
105+
106+ If you are going to document more than some few lines be sure to have a task
107+ opened in github and assign it to yourself before start the work to avoid
108+ doing the same work by two different people.
109+
110+ When documenting, try to be clear, concise and with a same style on all the
111+ text, and, if you are not sure about something in particular, please ask
112+ any question to
[email protected] .
85113
86114 Administrators
87115================
88116
89- The project needs administrators to update the website, maintain the
90- email lists, ... In the github issues page you can find some tasks to
117+ The project needs administrators to update the website, create and maintain
118+ the email lists, ... In the github issues page you can find some tasks to
91119do by the administrators sorted by difficulty and priority. If you want
92- to do any of the tasks please keep in touch with the rest of
93- administrators (ask at <
[email protected] >
94- for them) or write to <
[email protected] > in order to coordinate the
95- tasks.
120+ to do any of the tasks write to <
[email protected] > and assign yourself
121+ the issue in order to be coordinated.
96122
97123 Developers
98124============
99125
100- XXXXXX is handled in a git repository that you can find in the
101- github's project page at https://github.com/i02sopop/XXXXXX.
102- There is a developer mailing list at
[email protected] 103- and a mailing list for the commits at
[email protected] ,
104- and you can subscribe and access to them at https://lists.ritho.net.
105-
106- If you want to start collaborating with the project you can check the
107- issues category in the github page to see the bugs opened about the
108- project.
109-
110- TODO: Include information about the directory structure at the
111- repository.
126+ Snag is handled in a git repository that you can find in the github's
127+ project page at https://github.com/i02sopop/snag. In github we manage
128+ all the functionalities, bugs, tasks and so on, so if you want to
129+ collaborate adding new tasks or doing some of them you should go
130+ the github's issues to read if the task is already planned or if
131+ someone is doing already the task.
132+
133+ When the time comes, we'll create a list for developers, users, bugs,
134+ commits, ..., but if you want to collaborate in the project write
135+ [email protected] to coordinate the work.
136+
137+ The source code is in the src directory, and the header files are in
138+ the include directory. You have also some documentation in the docs
139+ directory, so feel free to start digging in those directories to learn
140+ about the code and start making changes.
0 commit comments