Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README before opening a new issue #186

Open
ranghetti opened this issue May 13, 2019 · 0 comments
Open

README before opening a new issue #186

ranghetti opened this issue May 13, 2019 · 0 comments

Comments

@ranghetti
Copy link
Owner

@ranghetti ranghetti commented May 13, 2019

Users are encouraged to use this section in case of errors using sen2r, or for any other purpose (questions, suggestions, ...). Please prefer this method instead than sending private email to the authors: this is helpful both for us (we can better manage help requests) and for users (it is possible to keep trace of already occurred errors).

If you encountered an error, please check if the problem was already been mentioned before opening a new issue. If a task regarding your problem is already present but it is closed, open a new issue citing the old task instead than reopening it.

In order to allow us reproducing your error, please describe your problem in as much detail as possible; in particular, follow the recommendations below.

  1. Provide a reproducible example of your problem; in particular, remember that:
    • to grant reproducibility, if you pass some R objects to function arguments (e.g., the spatial extent), you must pass them (e.g. attaching them);
    • if you are using the main function sen2r(), you can both paste the function specifying the argument values (as for other sen2r functions) or paste the content of the JSON parameter file which you are using (if you are not using a parameter file, export it with the button "Save options as..." in the GUI or report the complete sen2r(...) command with the argument values). This file is a text file, so you can open it with a text editor and copy its content. If your extent is the path of a spatial file, attach it to allow reproducibility.
  2. If you are re-launching a processing which you already used (i.e. if your output folders are not empty), report also the content of these directories.
  3. Do not report only the functions which you used, but also the output (in case of function sen2r(), post the complete output of the function, from #### Starting sen2r execution. #### to #### sen2r session terminated. ####).
  4. Detail which is your operating system and your R /sen2r version, by reporting the output of the commands sessionInfo() and packageVersion("sen2r").
  5. Report the output of the command sen2r::load_binpaths().

Moreover, update the package to the last available master or CRAN version before opening the issue: to do it, you need to reinstall sen2r with one of the following commands:

install.packages("sen2r")
remotes::install_github("ranghetti/sen2r")

If the problem was caused by a bug, you will need to reinstall the package (with the same command) after any patch provided by us.

Important: since reporting errors is useful both for you and for future users, you are strongly encouraged not only to report errors and asking/waiting for a solution, but also to answer us when we required details (generally outputs of R commands) in order to understand your problem (if our requests were not clear, feel free to ask for an explaination), and to give us a feedback (did the provided instructions contribute to solve the error? Did you solve it in another way?). In the case you will not provide this information once having your problem solved, we reserve the right to ignore your future requests.
Also, remember that sen2r is not a commercial tool, so developers are not obliged to provide assistance: please be polite and respect the Code of Conduct.
Tasks can be closed after 10 days of inactivity (you can reopen it if you need further help).

@ranghetti ranghetti pinned this issue May 13, 2019
Repository owner locked and limited conversation to collaborators May 13, 2019
@ranghetti ranghetti unpinned this issue Dec 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant