Jeśli chcesz udzielić się w kodzie BookWyrm, to świetnie! Jeśli istnieje otwarty problem, który chcesz naprawić, możesz zamieścić komentarz do niego, tak aby niczego nie powielać. Staraj się, aby zakres próśb o scalenie był mały i skupiony na jednym temacie. Dzięki temu łatwiej będzie ją sprawdzić i sprawniej wprowadzić zmiany.
Jeśli nie masz pewności, jak coś naprawić lub nie możesz się za to zabrać, to nic nie szkodzi i wystarczy, że zamieścisz komentarz do prośby o scalenie i wspólnie znajdziemy rozwiązanie 💖.
Pull requests have to pass all the automated checks before they can be merged - this includes style checks, global linters, a security check, and unit tests.
We use EditorConfig to maintain consistent indenting and line endings.
BookWyrm uses the Black code formatter to keep the Python codebase consistent styled. All new pull requests are checked with GitHub actions, and you can automatically fix code style problems by running ./bw-dev black
Code is also checked with Pylint using GitHub Actions. Pylint warnings must be addressed before pull requests are merged, but it's a judgement call if the suggestion should be used, or the warning suppressed. To suppress a warning, add a comment at the end of or on the line above the warnings: # pylint: disable=warning-name
Twoje prośby o scalenie zostaną również sprawdzone przez curlylint w poszukiwaniu szablonów Django.
Korzystamy z stylelint, do sprawdzania zasad CSS. Tak jak w przypadku Pylint możesz wyłączyć stylelint dla konkretnej zasady, ale należy mieć ku temu dobry powód.
ESLint sprawdza wszelkie wprowadzone zmiany w JavaScript. Jeśli ESLint nie będzie współpracował z Twoim kodem JavaScript, sprawdź wiadomości narzędzia po więcej informacji.
Bookwyrm aims to be as inclusive and accessible as possible.
When contributing code, check the Inclusive Web Design Checklist before you file your pull request. For accessibility advice, A11Y-101 is also a useful source. For information on how to make your page templates multi-lingual, see the Translations section.
Niektórymi z aspektów, które współtwórcy BookWyrm uznali za przydatne do zapamiętania są:
input[type="checkbox"] lub input[type="radio"] w znaczniku <label><label>, wówczas należy go umieścić za elementem, do którego się odwołuje<button> dla czegokolwiek, co istnieje, aby wywołać instrukcję JavaScript (np. ukrywanie i pokazywanie fomrularza) lub wysyła żądanie POST (np. przesłanie formularza)<a> dla czegokolwiek, co wywołuje żądanie GET. Zazwyczaj element znacznika odnośnika (<a>) nie powinien być stylizowany jako przycisk (class="button"), ale istnieje kilka wyjątków, takich jak przyciski "Anuluj". W razie wątpliwości zapytaj o poradę w swojej prośbie o scalenie