khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 02:36:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

Branding

Browse Source
This commit is contained in:
Lukas Reschke
2016-07-21 00:21:47 +02:00
parent 8de6b92fb5
commit 6ccd2c5678
105 changed files with 721 additions and 1559 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
developer_manual/bugtracker/codereviews.rst
View File

@@ -8,7 +8,7 @@ Code Reviews on GitHub
Introduction
------------
In order to increase the code quality within ownCloud, developers are requested
In order to increase the code quality within Nextcloud, developers are requested
to perform code reviews. As we are now heavily using the GitHub platform these
code review shall take place on GitHub as well.
@@ -42,7 +42,7 @@ How will it work?
Examples
--------
Read our `coding guidelines`_ for information on what a good pull request and
good ownCloud code looks like.
good Nextcloud code looks like.
These are two examples that are considered to be good examples of how pull
requests should be handled

8
developer_manual/bugtracker/index.rst
View File

@@ -10,12 +10,12 @@ Bugtracker
kanban
triaging
Thank you for helping ownCloud by reporting bugs. Before submitting an issue, please read
Thank you for helping Nextcloud by reporting bugs. Before submitting an issue, please read
`Issue submission guidelines`_ first.
* If the issue is with the ownCloud server, report it to the `Core repository`_
* If the issue is with the ownCloud client, report it to the `Client repository`_
* If the issue with with an ownCloud app, report it to where that app is developed
* If the issue is with the Nextcloud server, report it to the `Core repository`_
* If the issue is with the Nextcloud client, report it to the `Client repository`_
* If the issue with with an Nextcloud app, report it to where that app is developed
* If the app is listed in our `main github repository`_ report it to the correct sub
repository
* If the app is listed in the `apps repository`_ report it there

10
developer_manual/bugtracker/kanban.rst
View File

@@ -2,7 +2,7 @@ Kanban Board
============
This chapter contains a lot of information about the development process the
ownCloud community tries to follow, so please take your time to digest all the
Nextcloud community tries to follow, so please take your time to digest all the
information. In any case remember this page as the documentation on how it
should be done. Nothing here is set in stone, so if you think something should
be changed please discuss it on the `mailing list`_.
@@ -10,7 +10,7 @@ be changed please discuss it on the `mailing list`_.
Kanban Board = github issues + huboard
--------------------------------------
We are using http://huboard.com to visualize ownCloud github issues as a `kanban
We are using http://huboard.com to visualize Nextcloud github issues as a `kanban
board`_ (see: `core`_, `apps`_, `client`_):
.. figure:: ../images/kanbanexample.png
@@ -187,7 +187,7 @@ Why do we have it?
What does a developer think?
"Look at all the shiny things we will release with the next version of
ownCloud!"
Nextcloud!"
When can I pull?
This is the last step of the Kanban board. When the Release finally happens
@@ -221,7 +221,7 @@ Priority Labels
* Panic should be used with caution. It is reserved for Bugs that would result
in the loss of files or other user data. An Enhancement marked as Panic is
expected by ownCloud users for the next release. In either case an open Panic
expected by Nextcloud users for the next release. In either case an open Panic
issue will prevent a release.
* Attention is not as hard as Panic. But we really want this in the next release
@@ -257,7 +257,7 @@ Misc Labels
* Needs info – Either from a developer or the bug reporter. This is nearly as
severe as Panic, because no further action can be taken
* L18n – A translation issue go see our `transifex`_
* Junior Job – The issue is considered a good starting point to get involved in ownCloud development
* Junior Job – The issue is considered a good starting point to get involved in Nextcloud development
Milestones equal Releases
-------------------------

50
developer_manual/bugtracker/triaging.rst
View File

@@ -1,18 +1,18 @@
=====================
ownCloud Bug Triaging
Nextcloud Bug Triaging
=====================
.. toctree::
:maxdepth: 2
:hidden:
Bug Triaging is the process of checking bug reports to see if they are still valid (the problem might be solved since the bug was reported), reproducing them when possible (to make sure it really is an ownCloud issue and not a configuration problem) and in general making sure the bug is useful for a developer who wants to fix it. If the bug is not useful and can't be augmented by the original reporter or the triaging contributor, it has to be closed.
Bug Triaging is the process of checking bug reports to see if they are still valid (the problem might be solved since the bug was reported), reproducing them when possible (to make sure it really is an Nextcloud issue and not a configuration problem) and in general making sure the bug is useful for a developer who wants to fix it. If the bug is not useful and can't be augmented by the original reporter or the triaging contributor, it has to be closed.
Why do you want to join
=======================
Helping to bring the number of issues down makes it easier for developers to spend their time productively and bug triagers thus **contribute greatly to ownCloud development**! Triaging a bug doesn’t take long so the work comes in small chunks and you don’t need many skills, just some patience and sometimes perseverance.
Helping to bring the number of issues down makes it easier for developers to spend their time productively and bug triagers thus **contribute greatly to Nextcloud development**! Triaging a bug doesn’t take long so the work comes in small chunks and you don’t need many skills, just some patience and sometimes perseverance.
Bug triagers who contribute significantly should ask to be listed as an active contributor on the `owncloud.org <https://owncloud.org>`_ page!
Bug triagers who contribute significantly should ask to be listed as an active contributor on the `nextcloud.com <https://nextcloud.com>`_ page!
How do you triage bugs
======================
@@ -35,10 +35,10 @@ General considerations
======================
* You need a `github account <https://github.com>`_ to contribute to bug triaging.
* If you are not familiar with the github issue tracker interface (which is used by ownCloud to handle bug reports), you `may find this guide useful <https://guides.github.com/features/issues/>`_.
* If you are not familiar with the github issue tracker interface (which is used by Nextcloud to handle bug reports), you `may find this guide useful <https://guides.github.com/features/issues/>`_.
* You will initially only be able to comment on issues. The ability to close issues or assign labels will be given liberally to those who have shown to be willing and able to contribute. Just ask on IRC!
* Read `our bug reporting guidelines <https://github.com/owncloud/core/blob/master/CONTRIBUTING.md#submitting-issues>`_ so you know what a good report should look like and where things belong. The `issue template <https://raw.github.com/owncloud/core/master/issue_template.md>`_ asks specifically for some information developers need to solve issues.
* It might even be fixed, sometimes! It can also be fruitful to contact the `developers on irc <irc://freenode/#owncloud-dev>`_. Tell them you're triaging bugs and share what problem you bumped into. Or just ask on the test-pilots mailing list.
* Read `our bug reporting guidelines <https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md#submitting-issues>`_ so you know what a good report should look like and where things belong. The `issue template <https://raw.github.com/nextcloud/server/master/issue_template.md>`_ asks specifically for some information developers need to solve issues.
* It might even be fixed, sometimes! It can also be fruitful to contact the `developers on irc <irc://freenode/#nextcloud-dev>`_. Tell them you're triaging bugs and share what problem you bumped into. Or just ask on the test-pilots mailing list.
* To ensure no two people are working on the same issue, we ask you to simply add a comment like "I am triaging this" in the issue you want to work on, and when done, before or after executing the triaging actions, note similarly that you're done.
To be able to tag and close issues, you need to have access to the repository. For the core and sync app repositories this also means having signed the contributor agreement. However, this isn't really needed for triaging as you can comment after you're done triaging and somebody else can execute those actions.
@@ -48,11 +48,11 @@ Finding bugs to triage
Github offers several search queries which can be useful to find a list of bugs which deserve a closer look:
* `The bugs least recently commented on <https://github.com/issues?q=is%3Aissue+user%3Aowncloud+is%3Aopen+sort%3Aupdated-asc++is%3Apublic+>`_
* `Least commented issues <https://github.com/issues?q=is%3Aissue+user%3Aowncloud+is%3Aopen+no%3Aassignee+no%3Amilestone+no%3Alabel+sort%3Acomments-asc+>`_
* `Bugs which need info <https://github.com/issues?q=is%3Aissue+user%3Aowncloud+is%3Aopen+label%3A%22Needs+info%22+sort%3Acreated-asc+>`_
* `The bugs least recently commented on <https://github.com/issues?q=is%3Aissue+user%3Anextcloud+is%3Aopen+sort%3Aupdated-asc++is%3Apublic+>`_
* `Least commented issues <https://github.com/issues?q=is%3Aissue+user%3Anextcloud+is%3Aopen+no%3Aassignee+no%3Amilestone+no%3Alabel+sort%3Acomments-asc+>`_
* `Bugs which need info <https://github.com/issues?q=is%3Aissue+user%3Anextcloudcloud+is%3Aopen+label%3A%22Needs+info%22+sort%3Acreated-asc+>`_
But there are more methods. For example, if you are a user of ownCloud with a specific setup like using nginx as Web server or dropbox as storage, or using the encryption app, you could look for bugs with these keywords. You can then use your knowledge of your installation and your installation itself to see if bugs are (still) valid or reproduce them.
But there are more methods. For example, if you are a user of Nextcloud with a specific setup like using nginx as Web server or dropbox as storage, or using the encryption app, you could look for bugs with these keywords. You can then use your knowledge of your installation and your installation itself to see if bugs are (still) valid or reproduce them.
Once you have picked an issue, add a comment that you've started triaging:
@@ -72,7 +72,7 @@ Let's go over each step.
Finding duplicates
------------------
To find duplicates, the search tool in github is your first stop. In `this screen <https://github.com/owncloud/core/issues>`_ you can easily search for a few keywords from the bug report. If you find other bugs with the same content, decide what the best bug report is (often the oldest or the one where one or more developers have already started to engage and discuss the problem). That is the 'master' bug report, you can now close the other one (or comment that it can be closed as duplicate).
To find duplicates, the search tool in github is your first stop. In `this screen <https://github.com/nextcloud/server/issues>`_ you can easily search for a few keywords from the bug report. If you find other bugs with the same content, decide what the best bug report is (often the oldest or the one where one or more developers have already started to engage and discuss the problem). That is the 'master' bug report, you can now close the other one (or comment that it can be closed as duplicate).
If the bug report you were reviewing contains additional information, you can add that information to the 'master' bug report in a comment. Mention this bug report (using #<bug report number>) so a developer can look up the original, closed, report and perhaps ask the initial reporter there for additional information.
@@ -86,17 +86,17 @@ When the issue is a feature request, you can be helpful in the same way: merge r
Determining relevance of issue
------------------------------
Not all issues are relevant for ownCloud. Bugs can be due to a specific configuration or unsupported platforms. Raspberry Pi's suffer from SQLite time-outs, nginx has problems Apache doesn't and Microsoft Server with IIS is not well supported. While external issues are not always a reason to close a report, be sure that they are clear: does the user use the 'standard' platform? Ask for information if this is missing.
Not all issues are relevant for Nextcloud. Bugs can be due to a specific configuration or unsupported platforms. Raspberry Pi's suffer from SQLite time-outs, nginx has problems Apache doesn't and Microsoft Server with IIS is not well supported. While external issues are not always a reason to close a report, be sure that they are clear: does the user use the 'standard' platform? Ask for information if this is missing.
Last but not least, the problem might be due to the user doing something that simply does not work. Your general ownCloud knowledge might be helpful here - if this is the case, you can often swiftly close the issue with a comment about what went wrong.
Last but not least, the problem might be due to the user doing something that simply does not work. Your general Nextcloud knowledge might be helpful here - if this is the case, you can often swiftly close the issue with a comment about what went wrong.
.. note:: You might have to say no to some requests, for example when a problem has been solved in a new release but won't become available for the release the reporter is using; or when a solution has been chosen which the reporter is unhappy about. Be considerate. People feel surprisingly strong about ownCloud, and you should take care to explain that we don't aim to ignore them; on the contrary. But sometimes, decisions which benefit the majority of users don't help an individual. The extensibility and open availability of the code of ownCloud is here to relieve the pain of such decisions.
.. note:: You might have to say no to some requests, for example when a problem has been solved in a new release but won't become available for the release the reporter is using; or when a solution has been chosen which the reporter is unhappy about. Be considerate. People feel surprisingly strong about Nextcloud, and you should take care to explain that we don't aim to ignore them; on the contrary. But sometimes, decisions which benefit the majority of users don't help an individual. The extensibility and open availability of the code of Nextcloud is here to relieve the pain of such decisions.
Determining if the report is complete
-------------------------------------
Now that you know that the bug report is unique, and that is not an external issue, you need to check all the needed information is there.
Check `our bug reporting guidelines <https://github.com/owncloud/core/blob/master/CONTRIBUTING.md#submitting-issues>`_ and make sure bug reports comply with it! The information asked in the `issue template <https://raw.github.com/owncloud/core/master/issue_template.md>`_ is needed for developers to solve issues.
Check `our bug reporting guidelines <https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md#submitting-issues>`_ and make sure bug reports comply with it! The information asked in the `issue template <https://raw.github.com/nextcloud/server/master/issue_template.md>`_ is needed for developers to solve issues.
Once you added a request for more information, add a #needinfo tag.
@@ -110,7 +110,7 @@ This is needed in order to differentiate random/race condition bugs of reproduci
To reproduce an issue, please refer to our testing documents: :doc:`../testing/index`
If you can't reproduce an issue in a newer version of ownCloud, it is most likely fixed and can be closed. Comment that you failed to reproduce the problem, and if the reporter can confirm (or doesn't respond for a long time), you can close the issue. Also, be sure to add what exactly you tested with - the ownCloud Master or a branch (and if so, when), or did you use a release, and if so - what version?
If you can't reproduce an issue in a newer version of Nextcloud, it is most likely fixed and can be closed. Comment that you failed to reproduce the problem, and if the reporter can confirm (or doesn't respond for a long time), you can close the issue. Also, be sure to add what exactly you tested with - the Nextcloud Master or a branch (and if so, when), or did you use a release, and if so - what version?
Finalizing and tagging
----------------------
@@ -118,23 +118,11 @@ Once you are done reproducing an issue, it is time to finish up and make clear t
* If it is a genuine bug (or you are pretty sure it is) add the 'Bug' tag.
* If it is a genuine feature request (or you are pretty sure it is) add the 'enhancement' tag.
* If the issue is clearly related to something specific, @mention a maintainer. examples: @schiesbn for encryption, @blizzz for LDAP, @PVince81 for quota stuff... You can find a `list of maintainers here <https://github.com/owncloud/core/wiki/Maintainers>`_.
* If the issue is clearly related to something specific, @mention a maintainer. examples: @schiesbn for encryption, @blizzz for LDAP, @PVince81 for quota stuff... You can find a `list of maintainers here <https://github.com/nextcloud/server/wiki/Maintainers>`_.
Now, the developers can pick the issue up. Note that while we wish we would always pick up and solve problems promptly, not all areas of ownCloud get the same amount of attention and contribution, so this can occasionally take a long time.
Now, the developers can pick the issue up. Note that while we wish we would always pick up and solve problems promptly, not all areas of Nextcloud get the same amount of attention and contribution, so this can occasionally take a long time.
Collaboration
=============
You can just get started with bug triaging. But if you want, you can register on the `testpilot mailing list <https://mailman.owncloud.org/mailman/listinfo/testpilots>`_ and perhaps introduce yourself to `testpilots@owncloud.org <testpilots@owncloud.org>`_. On this list we announce and discuss testing and bug triaging related subjects.
You can also join the **#owncloud-testing** channel on **irc.freenode.net** (`link for IRC clients <irc://#owncloud-testing@freenode.net>`_ and `link to webchat <https://webchat.freenode.net/>`_) to ask questions but keep in mind that people aren't active 24/7 and it can occasionally take a while to get a response. Last but not least, ownCloud contributor `Jan Borchardt has a great guide for developers and triagers <https://gist.github.com/jancborchardt/6155185>`_ about dealing with issues, including some 'stock answers' and thoughts on how to deal with pull requests.
For further questions or help you can also send a mail to:
* X (IRC: Y)
We are looking forward to working with you!
**Credit:** this document is in debt to the extensive `KDE guide to bug triaging <https://techbase.kde.org/Contribute/Bugsquad/Guide_To_BugTriaging>`_.