add more precise rules to CONTRIBUTING.md #3423
Conversation
Add extra rules that clang-format enforces, like the order of includes and the way single line comments should be formatted. Correct some grammar ( what is up with the translation section ordering steps out of order?? ). This is a web edit.
|
Damn, so many typos. 🙈
Can you give more details, please? |
|
The translation section lists five steps but when explaining the five steps they are listed as 1, 2, 3, 5, 4; likely to separate them over different roles (dev, maintainer, translator) but it's just confusing. |
|
Ahh, got you now! And you are right in your assumption, that was the idea behind it. But I'll look into improving that and at least add some linking. |
|
I say ditch the step numbers in the explanation and see them as guides per target user, it should mention in the maintainer guide that translators do something in between the last two steps of course. |
|
For now I added links to the ordered structure and a jumplist per "user type": Will look further and consider your input in the next days. 👍 |
Remove the weird out of order numbering and replace it with just chapters for specific users. Add a bit of explanation to adding translations as a developer. This is just a recommendation for an improvement, jumplist could be added and/or Cockatrice#3423 merged with this. (it fixes the typos)
|
I created a different pr from the web ui to show how I think the translating chapter would be more readable #3424 , feel free to close it if you want to preserve the current step layout. |
Remove the weird out of order numbering and replace it with just chapters for specific users. Add a bit of explanation to adding translations as a developer. This is just a recommendation for an improvement, jumplist could be added and/or #3423 merged with this. (it fixes the typos)
|
Conflicts will need to be resolved b4 i can merge this |
|
merged, I expected the other pr to be rejected or merged after this one. |
Add extra rules that clang-format enforces, like the order of includes and the way single line comments should be formatted.
Correct some grammar ( what is up with the translation section ordering steps out of order?? ).
This is a web edit.