432 lines
13 KiB
Plaintext
432 lines
13 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2010-2018, Read the Docs, Inc & contributors
|
|
# This file is distributed under the same license as the Read the Docs package.
|
|
#
|
|
# Translators:
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: readthedocs-docs\n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2018-09-17 19:05-0500\n"
|
|
"PO-Revision-Date: 2018-09-18 00:14+0000\n"
|
|
"Last-Translator: Anthony <aj@ohess.org>\n"
|
|
"Language-Team: Persian (http://www.transifex.com/readthedocs/readthedocs-docs/language/fa/)\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
"Language: fa\n"
|
|
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
|
|
|
|
#: ../../contribute.rst:2
|
|
msgid "Contributing to Read the Docs"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:4
|
|
msgid ""
|
|
"You are here to help on Read the Docs? Awesome, feel welcome and read the "
|
|
"following sections in order to know how to ask questions and how to work on "
|
|
"something."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:7
|
|
msgid ""
|
|
"All members of our community are expected to follow our :doc:`/code-of-"
|
|
"conduct`. Please make sure you are welcoming and friendly in all of our "
|
|
"spaces."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:11
|
|
msgid "Get in touch"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:13
|
|
msgid "Ask usage questions (\"How do I?\") on `StackOverflow`_."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:14
|
|
msgid "Report bugs, suggest features or view the source code `on GitHub`_."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:15
|
|
msgid "Discuss topics on `Gitter`_."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:16
|
|
msgid "On IRC find us at `#readthedocs`_."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:24
|
|
msgid "Contributing to development"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:26
|
|
msgid ""
|
|
"If you want to deep dive and help out with development on Read the Docs, "
|
|
"then first get the project installed locally according to the "
|
|
":doc:`Installation Guide <install>`. After that is done we suggest you have "
|
|
"a look at tickets in our issue tracker that are labelled `Good First "
|
|
"Issue`_. These are meant to be a great way to get a smooth start and won't "
|
|
"put you in front of the most complex parts of the system."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:33
|
|
msgid ""
|
|
"If you are up to more challenging tasks with a bigger scope, then there are "
|
|
"a set of tickets with a `Feature`_ or `Improvement`_ tag. These tickets have"
|
|
" a general overview and description of the work required to finish. If you "
|
|
"want to start somewhere, this would be a good place to start (make sure that"
|
|
" the issue also have the `Accepted`_ label). That said, these aren't "
|
|
"necessarily the easiest tickets. They are simply things that are explained. "
|
|
"If you still didn't find something to work on, search for the `Sprintable`_ "
|
|
"label. Those tickets are meant to be standalone and can be worked on ad-hoc."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:43
|
|
msgid ""
|
|
"When contributing code, then please follow the standard Contribution "
|
|
"Guidelines set forth at `contribution-guide.org`_."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:46
|
|
msgid ""
|
|
"We have a strict code style that is easy to follow since you just have to "
|
|
"install `pre-commit`_ and it will automatically run different linting tools "
|
|
"(`autoflake`_, `autopep8`_, `docformatter`_, `isort`_, `prospector`_, "
|
|
"`unify`_ and `yapf`_) to check your changes before you commit them. `pre-"
|
|
"commit` will let you know if there were any problems that is wasn't able to "
|
|
"fix automatically."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:52
|
|
msgid "To run the `pre-commit` command and check your changes::"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:58
|
|
msgid "or to run against a specific file::"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:62
|
|
msgid ""
|
|
"`pre-commit` can also be run as a git pre-commit hook. You can set this up "
|
|
"with::"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:67
|
|
msgid ""
|
|
"After this installation, the next time you run `git commit` the `pre-commit "
|
|
"run` command will be run immediately and will inform you of the changes and "
|
|
"errors."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:72
|
|
msgid ""
|
|
"Our code base is still maturing and the core team doesn't yet recommend "
|
|
"running this as a pre-commit hook due to the number of changes this will "
|
|
"cause while constructing a pull request. Independent pull requests with "
|
|
"linting changes would be a great help to making this possible."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:95
|
|
msgid "Triaging tickets"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:97
|
|
msgid ""
|
|
"Here is a brief explanation on how we triage incoming tickets to get a "
|
|
"better sense of what needs to be done on what end."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:100
|
|
msgid ""
|
|
"You will need Triage permission on the project in order to do this. You can "
|
|
"ask one of the members of the :doc:`team` to give you access."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:104
|
|
msgid "Initial triage"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:106
|
|
msgid ""
|
|
"When sitting down to do some triaging work, we start with the `list of "
|
|
"untriaged tickets`_. We consider all tickets that do not have a label as "
|
|
"untriaged. The first step is to categorize the ticket into one of the "
|
|
"following categories and either close the ticket or assign an appropriate "
|
|
"label. The reported issue …"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:127
|
|
msgid "… is not valid"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:113
|
|
msgid ""
|
|
"If you think the ticket is invalid comment why you think it is invalid, then"
|
|
" close the ticket. Tickets might be invalid if they were already fixed in "
|
|
"the past or it was decided that the proposed feature will not be implemented"
|
|
" because it does not conform with the overall goal of Read the Docs. Also if"
|
|
" you happen to know that the problem was already reported, reference the "
|
|
"other ticket that is already addressing the problem and close the duplicate."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:120 ../../contribute.rst:141 ../../contribute.rst:153
|
|
#: ../../contribute.rst:165 ../../contribute.rst:174 ../../contribute.rst:183
|
|
#: ../../contribute.rst:193 ../../contribute.rst:203
|
|
msgid "Examples:"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:122
|
|
msgid ""
|
|
"*Builds fail when using matplotlib*: If the described issue was already "
|
|
"fixed, then explain and instruct to re-trigger the build."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:125
|
|
msgid ""
|
|
"*Provide way to upload arbitrary HTML files*: It was already decided that "
|
|
"Read the Docs is not a dull hosting platform for HTML. So explain this and "
|
|
"close the ticket."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:144
|
|
msgid "… does not provide enough information"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:132
|
|
msgid ""
|
|
"Add the label **Needed: more information** if the reported issue does not "
|
|
"contain enough information to decide if it is valid or not and ask on the "
|
|
"ticket for the required information to go forward. We will re-triage all "
|
|
"tickets that have the label **Needed: more information** assigned. If the "
|
|
"original reporter left new information we can try to re-categorize the "
|
|
"ticket. If the reporter did not come back to provide more required "
|
|
"information after a long enough time, we will close the ticket (this will be"
|
|
" roughly about two weeks)."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:143
|
|
msgid ""
|
|
"*My builds stopped working. Please help!* Ask for a link to the build log "
|
|
"and for which project is affected."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:157
|
|
msgid "… is a valid feature proposal"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:147
|
|
msgid ""
|
|
"If the ticket contains a feature that aligns with the goals of Read the "
|
|
"Docs, then add the label **Feature**. If the proposal seems valid but "
|
|
"requires further discussion between core contributors because there might be"
|
|
" different possibilities on how to implement the feature, then also add the "
|
|
"label **Needed: design decision**."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:155
|
|
msgid "*Provide better integration with service XYZ*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:156
|
|
msgid ""
|
|
"*Achieve world domination* (also needs the label **Needed: design "
|
|
"decision**)"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:168
|
|
msgid "… is a small change to the source code"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:160
|
|
msgid ""
|
|
"If the ticket is about code cleanup or small changes to existing features "
|
|
"would likely have the **Improvement** label. The distinction for this label "
|
|
"is that these issues have a lower priority than a Bug, and aren't "
|
|
"implementing new features."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:167
|
|
msgid "*Refactor namedtuples to dataclasess*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:168
|
|
msgid "*Change font size for the project's title*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:176
|
|
msgid "… is a valid problem within the code base:"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:171
|
|
msgid ""
|
|
"If it's a valid bug, then add the label **Bug**. Try to reference related "
|
|
"issues if you come across any."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:176
|
|
msgid "*Builds fail if conf.py contains non-ascii letters*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:185
|
|
msgid "… is a currently valid problem with the infrastructure:"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:179
|
|
msgid ""
|
|
"Users might report about web server downtimes or that builds are not "
|
|
"triggered. If the ticket needs investigation on the servers, then add the "
|
|
"label **Operations**."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:185
|
|
msgid "*Builds are not starting*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:197
|
|
msgid "… is a question and needs answering:"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:190
|
|
msgid ""
|
|
"If the ticket contains a question about the Read the Docs platform or the "
|
|
"code, then add the label **Support**."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:195
|
|
msgid "*My account was set inactive. Why?*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:196
|
|
msgid "*How to use C modules with Sphinx autodoc?*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:197
|
|
msgid "*Why are my builds failing?*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:206
|
|
msgid "… requires a one-time action on the server:"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:200
|
|
msgid ""
|
|
"Tasks that require a one time action on the server should be assigned the "
|
|
"two labels **Support** and **Operations**."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:205
|
|
msgid "*Please change my username*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:206
|
|
msgid "*Please set me as owner of this abandoned project*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:208
|
|
msgid ""
|
|
"After we finished the initial triaging of new tickets, no ticket should be "
|
|
"left without a label."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:214
|
|
msgid "Additional labels for categorization"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:216
|
|
msgid ""
|
|
"Additionally to the labels already involved in the section above, we have a "
|
|
"few more at hand to further categorize issues."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:221
|
|
msgid "*High Priority*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:220
|
|
msgid ""
|
|
"If the issue is urgent, assign this label. In the best case also go forward "
|
|
"to resolve the ticket yourself as soon as possible."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:226
|
|
msgid "*Good First Issue*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:224
|
|
msgid ""
|
|
"This label marks tickets that are easy to get started with. The ticket "
|
|
"should be ideal for beginners to dive into the code base. Better is if the "
|
|
"fix for the issue only involves touching one part of the code."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:230
|
|
msgid "*Sprintable*"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:229
|
|
msgid ""
|
|
"Sprintable are all tickets that have the right amount of scope to be handled"
|
|
" during a sprint. They are very focused and encapsulated."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:232
|
|
msgid ""
|
|
"For a full list of available labels and their meanings, see :doc:`issue-"
|
|
"labels`."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:236
|
|
msgid "Helpful links for triaging"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:238
|
|
msgid "Here is a list of links for contributors that look for work:"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:240
|
|
msgid ""
|
|
"`Untriaged tickets "
|
|
"<https://github.com/rtfd/readthedocs.org/issues?q=is:issue+is:open+no:label>`_:"
|
|
" Go and triage them!"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:243
|
|
msgid ""
|
|
"`Tickets labelled with Needed: more information "
|
|
"<https://github.com/rtfd/readthedocs.org/issues?utf8=✓&q=is:open+is:issue+label:\"Needed:+more+information\">`_:"
|
|
" Come back to these tickets once in a while and close those that did not get"
|
|
" any new information from the reporter. If new information is available, go "
|
|
"and re-triage the ticket."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:248
|
|
msgid ""
|
|
"`Tickets labelled with Operations "
|
|
"<https://github.com/rtfd/readthedocs.org/issues?q=is:open+is:issue+label:Operations>`_:"
|
|
" These tickets are for contributors who have access to the servers."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:251
|
|
msgid ""
|
|
"`Tickets labelled with Support "
|
|
"<https://github.com/rtfd/readthedocs.org/issues?q=is:open+is:issue+label:Support>`_:"
|
|
" Experienced contributors or community members with a broad knowledge about "
|
|
"the project should handle those."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:255
|
|
msgid ""
|
|
"`Tickets labelled with Needed: design decision "
|
|
"<https://github.com/rtfd/readthedocs.org/issues?q=is:open+is:issue+label:\"Needed:+design+decision\">`_:"
|
|
" Project leaders must take actions on these tickets. Otherwise no other "
|
|
"contributor can go forward on them."
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:261
|
|
msgid "Helping on translations"
|
|
msgstr ""
|
|
|
|
#: ../../contribute.rst:263
|
|
msgid "If you wish to contribute translations, please do so on `Transifex`_."
|
|
msgstr ""
|