diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bde186332..7dd92963d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -10,14 +10,12 @@ Pontoon source code is available via GitHub: https://github.com/mozilla/pontoon -Bugs -==== +Issues +====== -All bugs are tracked in ``_. +Our work is tracked in `GitHub `_. -Write up a new bug: - -https://bugzilla.mozilla.org/enter_bug.cgi?product=Webtools&component=Pontoon +Report a `new issue `_: Docker @@ -159,14 +157,15 @@ Git conventions The first line is a summary of the commit. It should start with one of the following:: - Fix bug XXXXXXX + Fix #1234 or:: - Bug XXXXXXX + #1234 -The first, when it lands, will cause the bug to be closed. The second one does not. +The first, when it lands, will cause the issue to be closed. The second one just adds +a cross-reference. After that, the commit should explain *why* the changes are being made and any notes that future readers should know for context or be aware of. @@ -185,7 +184,7 @@ We follow `The seven rules of a great Git commit message `_, Mozilla's bug tracking -software. You will need to create an account there in order to be -assigned to a bug. +`GitHub `_, where we maintain +a list of what we deem `good first issues `_. -We maintain a list of what we deem "good first bugs". They are marked as -mentored on bugzilla, and can be found quickly on our `Pontoon wiki -page `_ or through -`this bugzilla -search `_. -Look through that list for unassigned bugs (marked as ``NEW``), choose -one that is appealing to you and seems adapted to your skill set, then -comment on that bug asking to be assigned to it. Feel free to start +Look through that list for unassigned issues, choose +one that is appealing to you and seems appropriate for your skill set, then +comment on that issue asking to be assigned to it. Feel free to start working on it right away — even if you end up not being assigned for -some reason, it will still be good experience for you. +some reason, it will still be a good experience for you. 6. Read the contributing rules ------------------------------ @@ -180,26 +174,15 @@ are where you should introduce yourself, ask questions, show your work, etc. Pontoon's core developer team is currently composed of Matjaž and -Adrian, with occasional help from other members of Mozilla's L10n team, -Axel and Staś. We also receive invaluable help from community members. +Eemeli. We also regularly receive invaluable help from community members. +------------+----------+--------------------------+------------------+-----------------------------------------------+ | | Name | ROLE | chat.mozilla.org | github | +============+==========+==========================+==================+===============================================+ -| |image4| | Matjaž | Pontoon Core Developer | mathjazz | `mathjazz `_ | +| |image0| | Matjaž | Pontoon Core Developer | mathjazz | `mathjazz `_ | +------------+----------+--------------------------+------------------+-----------------------------------------------+ -| |image5| | Adrian | Pontoon Core Developer | adrian | `adngdb `_ | -+------------+----------+--------------------------+------------------+-----------------------------------------------+ -| |image6| | Axel | L10n Tech Lead | Pike | `Pike `_ | -+------------+----------+--------------------------+------------------+-----------------------------------------------+ -| |image7| | Staś | Fluent Core Developer | stas | `stasm `_ | +| |image1| | Eemeli | Pontoon Core Developer | eemeli | `eemeli `_ | +------------+----------+--------------------------+------------------+-----------------------------------------------+ .. |image0| image:: https://avatars2.githubusercontent.com/u/626716?s=32&v=4 -.. |image1| image:: https://avatars1.githubusercontent.com/u/328790?s=32&v=4 -.. |image2| image:: https://avatars3.githubusercontent.com/u/43494?s=32&v=4 -.. |image3| image:: https://avatars2.githubusercontent.com/u/265818?s=32&v=4 -.. |image4| image:: https://avatars2.githubusercontent.com/u/626716?s=32&v=4 -.. |image5| image:: https://avatars1.githubusercontent.com/u/328790?s=32&v=4 -.. |image6| image:: https://avatars3.githubusercontent.com/u/43494?s=32&v=4 -.. |image7| image:: https://avatars2.githubusercontent.com/u/265818?s=32&v=4 +.. |image1| image:: https://avatars3.githubusercontent.com/u/617000?s=32&v=4 diff --git a/specs/0000-template.md b/specs/0000-template.md index 0cd913664..41ecf305a 100644 --- a/specs/0000-template.md +++ b/specs/0000-template.md @@ -1,6 +1,6 @@ - Feature Name: Name Of The Feature - Created: YYYY-MM-DD -- Associated Bug: https://bugzilla.mozilla.org/show_bug.cgi?id=BUG-ID +- Associated Issue: #ISSUE-ID # Summary @@ -14,7 +14,7 @@ Explain the rationale for developing the new feature — what value does it prov A general explanation of a feature written from the perspective of the end user. Define user interface and user interactions precisely enough for developers to be able to start coding. -This section also provides a concise technical specification, but keep in mind that once the specification is approved, bugs will be filed with all implementation details. +This section also provides a concise technical specification, but keep in mind that once the specification is approved, issues will be filed with all the implementation details. Note that we use present simple tense across the entire specification.