Mercurial > imgup
comparison CONTRIBUTE.md @ 7:1cf90affaa33
misc: rename the project to imgup
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 26 Nov 2020 19:13:08 +0100 |
parents | f41e1b48510d |
children |
comparison
equal
deleted
inserted
replaced
6:882acedb9b89 | 7:1cf90affaa33 |
---|---|
1 imgpaster CONTRIBUTING GUIDE | 1 imgup CONTRIBUTING GUIDE |
2 ============================ | 2 ======================== |
3 | 3 |
4 Read this guide if you want to contribute to imgpaster. The purpose of this | 4 Read this guide if you want to contribute to imgup. The purpose of this |
5 document is to describe the steps to submit a patch. | 5 document is to describe the steps to submit a patch. |
6 | 6 |
7 You may submit a patch when: | 7 You may submit a patch when: |
8 | 8 |
9 - You want to fix a bug / typo, | 9 - You want to fix a bug / typo, |
15 the rules. | 15 the rules. |
16 | 16 |
17 Subscribe to the mailing list | 17 Subscribe to the mailing list |
18 ----------------------------- | 18 ----------------------------- |
19 | 19 |
20 Discussion and patches are sent to the *imgpaster@malikania.fr* mailing list. | 20 Discussion and patches are sent to the *imgup@malikania.fr* mailing list. |
21 You need to subscribe by dropping a mail to | 21 You need to subscribe by dropping a mail to |
22 *imgpaster+subscribe@malikania.fr* first. | 22 *imgup+subscribe@malikania.fr* first. |
23 | 23 |
24 Enable patchbomb extension | 24 Enable patchbomb extension |
25 -------------------------- | 25 -------------------------- |
26 | 26 |
27 While this step is optional, it brings the `hg email` command which makes most | 27 While this step is optional, it brings the `hg email` command which makes most |
36 Then, you need to specify a mail server, if you want to use smtp, you can use | 36 Then, you need to specify a mail server, if you want to use smtp, you can use |
37 something like this: | 37 something like this: |
38 | 38 |
39 [email] | 39 [email] |
40 from = Your Name <youraddress@yourdomain.tld> | 40 from = Your Name <youraddress@yourdomain.tld> |
41 to = imgpaster@malikania.fr | 41 to = imgup@malikania.fr |
42 | 42 |
43 [smtp] | 43 [smtp] |
44 host = yourdomain.tld | 44 host = yourdomain.tld |
45 port = 587 | 45 port = 587 |
46 tls = starttls | 46 tls = starttls |
77 password = the_generated_application_password | 77 password = the_generated_application_password |
78 | 78 |
79 Create your patch | 79 Create your patch |
80 ----------------- | 80 ----------------- |
81 | 81 |
82 Usually, when you create a patch, you should have your own copy of imgpaster | 82 Usually, when you create a patch, you should have your own copy of imgup |
83 in your directory. | 83 in your directory. |
84 | 84 |
85 The following steps assumes that you have already cloned the imgpaster | 85 The following steps assumes that you have already cloned the imgup |
86 repository somewhere. | 86 repository somewhere. |
87 | 87 |
88 Note: the recommended way is to create one unique revision. | 88 Note: the recommended way is to create one unique revision. |
89 | 89 |
90 ### Commit messages | 90 ### Commit messages |