Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

97 lines (66 loc) · 4.72 KB

Contributing to WorldWind Android

Table of Contents

Asking Questions

Contributing

Resources

Asking Questions

Please do not file an issue to ask a question. You will get faster results by using the following resources:

Contributing

Reporting Bugs

This section guides you through submitting a bug report to WorldWind Android. Following these guidelines helps both the WorldWind team and community understand your report, reproduce the behavior, and find related reports.

Before Submitting a Bug Report

  • Check the WorldWind Forum.
  • Check this repository's issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

Note: If you find a Closed issue that seems like it is similar to what you are experiencing, open a new issue and include a link to the original issue in the body of your new one.

Submitting a Good Bug Report

Bugs are tracked as GitHub issues. After you've complete the prerequisites for submitting a bug, create an issue in the appropriate repository and providing the following information by filling out the template.

Explain the problem and include additional details to help the WorldWind team reproduce the problem:

  • Use a clear, descriptive title.
  • Describe the exact steps which reproduce the problem. Please be as detailed as possible. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples. Include the appropriate files, links, or code snippets which will help the WorldWind team and community better understand the issue.
  • Describe the behavior. Detail what behavior you observed and point out what is wrong with that behavior. Explain which behavior you expected to see and why.

Provide more context by answering these questions:

  • Did the problem start happening recently?
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • Does the problem happen for all files, or only some?
  • What is the name and version of the OS you're running?

Suggesting New Features

This section guides you through submitting and enhancement for WorldWind Android, including completely new features and minor improvements to existing functionalities. Following these guidelines helps the WorldWind team and community understand your suggestion and find related suggestions.

Before creating new feature suggestions, check this repository's issues as you may find out that you don't need to create one. When you are creating an enhancement suggestion, please provide as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Submitting a Good New Feature Suggestion

New feature suggestions are tracked as GitHub Issues. After you've checked for existing issues that might relate to your suggestion, create an issue in the appropriate repository and provide the following information:

  • Use a clear and descriptive title.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Explain why this enhancement would be beneficial to most WorldWind users.
  • Specify the name and version of the OS you're using.

Pull Requests

  • Fill in the PULL_REQUEST template.
  • Do not include issue numbers in the PR title.
  • Provide a description of the change.
  • Explain why this code should be in the core.
  • Describe possible benefits and drawbacks from merging this pull request.
  • Specify some issues to which this pull request is applicable.

Resources

For WorldWind Android tutorials and examples, please check out our website: https://worldwind.arc.nasa.gov/.

For community support and FAQs, check out the WorldWind Forum: https://forum.worldwindcentral.com/.

To reach our Administrative Contact, please email: [email protected].