Bug 1688846: Point contributing docs from Bugzilla to GitHub (#1999)

Also:
* Add Security Policy to point vulnerability reports to Bugzilla
* Update spec template
* Update core team contacts
This commit is contained in:
Matjaž Horvat 2021-09-13 21:05:29 +02:00 коммит произвёл GitHub
Родитель 51baa88fa4
Коммит 5ff706b08a
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
6 изменённых файлов: 37 добавлений и 49 удалений

Просмотреть файл

@ -10,14 +10,12 @@ Pontoon source code is available via GitHub:
https://github.com/mozilla/pontoon https://github.com/mozilla/pontoon
Bugs Issues
==== ======
All bugs are tracked in `<https://bugzilla.mozilla.org/>`_. Our work is tracked in `GitHub <https://github.com/mozilla/pontoon/issues>`_.
Write up a new bug: Report a `new issue <https://github.com/mozilla/pontoon/issues/new>`_:
https://bugzilla.mozilla.org/enter_bug.cgi?product=Webtools&component=Pontoon
Docker Docker
@ -159,14 +157,15 @@ Git conventions
The first line is a summary of the commit. It should start with one of the following:: The first line is a summary of the commit. It should start with one of the following::
Fix bug XXXXXXX Fix #1234
or:: 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 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. 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 <https://chris.beams.io
Pull requests Pull requests
============= =============
Pull request summary should indicate the bug the pull request addresses. Pull request summary should indicate the issue the pull request addresses.
Pull request descriptions should cover at least some of the following: Pull request descriptions should cover at least some of the following:

Просмотреть файл

@ -40,8 +40,8 @@ database, run tests, and send your contribution.
If you want to go further, you can: If you want to go further, you can:
* Check out development roadmap on the [wiki](https://wiki.mozilla.org/Pontoon) * Check out development roadmap on the [wiki](https://wiki.mozilla.org/Pontoon)
* File a [bug](https://bugzilla.mozilla.org/enter_bug.cgi?product=Webtools&component=Pontoon&rep_platform=all&op_sys=all) * Report an [issue](https://github.com/mozilla/pontoon/issues/new)
* Check [existing bugs](https://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Pontoon&resolution=---&list_id=13740920) * Check [existing issues](https://github.com/mozilla/pontoon/issues)
* See Mozilla's Pontoon servers: * See Mozilla's Pontoon servers:
* [Staging](https://mozilla-pontoon-staging.herokuapp.com/) * [Staging](https://mozilla-pontoon-staging.herokuapp.com/)
* [Production](https://pontoon.mozilla.org/) * [Production](https://pontoon.mozilla.org/)

7
SECURITY.md Normal file
Просмотреть файл

@ -0,0 +1,7 @@
# Security Policy
## Reporting a Vulnerability
To report a security vulnerability, please use [Bugzilla](https://bugzilla.mozilla.org/enter_bug.cgi?product=Websites&component=Pontoon%20Security%20Issues),
Mozilla's bug tracking software. It allows us to hide security problems from
the public until they are resolved.

Просмотреть файл

@ -11,15 +11,14 @@
"chat": "https://chat.mozilla.org/#/room/#pontoon:mozilla.org", "chat": "https://chat.mozilla.org/#/room/#pontoon:mozilla.org",
"chat-contacts": [ "chat-contacts": [
"mathjazz", "mathjazz",
"adrian", "eemeli"
"Pike"
], ],
"mailing-list": "https://discourse.mozilla.org/c/pontoon" "mailing-list": "https://discourse.mozilla.org/c/pontoon"
}, },
"bugs": { "bugs": {
"list": "https://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Pontoon", "list": "https://github.com/mozilla/pontoon/issues",
"report": "https://bugzilla.mozilla.org/enter_bug.cgi?product=Webtools&component=Pontoon", "report": "https://github.com/mozilla/pontoon/issues/new",
"mentored": "https://bugzilla.mozilla.org/buglist.cgi?f1=bug_mentor&o1=isnotempty&query_format=advanced&bug_status=NEW&product=Webtools&component=Pontoon" "mentored": "https://github.com/mozilla/pontoon/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22"
}, },
"urls": { "urls": {
"prod": "https://pontoon.mozilla.org", "prod": "https://pontoon.mozilla.org",

Просмотреть файл

@ -104,28 +104,22 @@ the command ``make test``.
When you have successfully verified that your setup works correctly, you When you have successfully verified that your setup works correctly, you
can safely move to the next part. can safely move to the next part.
5. Choose a bug to work on 5. Choose an issue to work on
-------------------------- -----------------------------
*You are now ready to make a contribution! Open source projects usually *You are now ready to make a contribution! Open source projects usually
have a list of mentored bugs that are appropriate to work on first, and have a list of mentored issues that are appropriate to work on first, and
on which mentors will be available to help you.* on which mentors will be available to help you.*
Work that needs to be done on Pontoon is tracked in Work that needs to be done on Pontoon is tracked in
`bugzilla <https://bugzilla.mozilla.org/>`_, Mozilla's bug tracking `GitHub <https://github.com/mozilla/pontoon/issues>`_, where we maintain
software. You will need to create an account there in order to be a list of what we deem `good first issues <https://github.com/mozilla/pontoon/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_.
assigned to a bug.
We maintain a list of what we deem "good first bugs". They are marked as Look through that list for unassigned issues, choose
mentored on bugzilla, and can be found quickly on our `Pontoon wiki one that is appealing to you and seems appropriate for your skill set, then
page <https://wiki.mozilla.org/L10n:Pontoon#Get_involved>`_ or through comment on that issue asking to be assigned to it. Feel free to start
`this bugzilla
search <https://bugzilla.mozilla.org/buglist.cgi?f1=bug_mentor&list_id=15050149&o1=isnotempty&resolution=---&classification=Server%20Software&query_format=advanced&emailbug_mentor1=1&component=Pontoon&product=Webtools>`_.
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
working on it right away — even if you end up not being assigned for 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 6. Read the contributing rules
------------------------------ ------------------------------
@ -180,26 +174,15 @@ are where you should introduce yourself, ask questions, show your work,
etc. etc.
Pontoon's core developer team is currently composed of Matjaž and Pontoon's core developer team is currently composed of Matjaž and
Adrian, with occasional help from other members of Mozilla's L10n team, Eemeli. We also regularly receive invaluable help from community members.
Axel and Staś. We also receive invaluable help from community members.
+------------+----------+--------------------------+------------------+-----------------------------------------------+ +------------+----------+--------------------------+------------------+-----------------------------------------------+
| | Name | ROLE | chat.mozilla.org | github | | | Name | ROLE | chat.mozilla.org | github |
+============+==========+==========================+==================+===============================================+ +============+==========+==========================+==================+===============================================+
| |image4| | Matjaž | Pontoon Core Developer | mathjazz | `mathjazz <https://github.com/mathjazz/>`_ | | |image0| | Matjaž | Pontoon Core Developer | mathjazz | `mathjazz <https://github.com/mathjazz/>`_ |
+------------+----------+--------------------------+------------------+-----------------------------------------------+ +------------+----------+--------------------------+------------------+-----------------------------------------------+
| |image5| | Adrian | Pontoon Core Developer | adrian | `adngdb <https://github.com/adngdb/>`_ | | |image1| | Eemeli | Pontoon Core Developer | eemeli | `eemeli <https://github.com/eemeli/>`_ |
+------------+----------+--------------------------+------------------+-----------------------------------------------+
| |image6| | Axel | L10n Tech Lead | Pike | `Pike <https://github.com/Pike/>`_ |
+------------+----------+--------------------------+------------------+-----------------------------------------------+
| |image7| | Staś | Fluent Core Developer | stas | `stasm <https://github.com/stasm/>`_ |
+------------+----------+--------------------------+------------------+-----------------------------------------------+ +------------+----------+--------------------------+------------------+-----------------------------------------------+
.. |image0| image:: https://avatars2.githubusercontent.com/u/626716?s=32&v=4 .. |image0| image:: https://avatars2.githubusercontent.com/u/626716?s=32&v=4
.. |image1| image:: https://avatars1.githubusercontent.com/u/328790?s=32&v=4 .. |image1| image:: https://avatars3.githubusercontent.com/u/617000?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

Просмотреть файл

@ -1,6 +1,6 @@
- Feature Name: Name Of The Feature - Feature Name: Name Of The Feature
- Created: YYYY-MM-DD - Created: YYYY-MM-DD
- Associated Bug: https://bugzilla.mozilla.org/show_bug.cgi?id=BUG-ID - Associated Issue: #ISSUE-ID
# Summary # 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. 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. Note that we use present simple tense across the entire specification.