Skip to content

Commit

Permalink
Updated WorldWind Android documentation (#146)
Browse files Browse the repository at this point in the history
- Added ISSUE_TEMPLATE.md, which outlines the expectations for submitting an issue
- Added PULL_REQUEST_TEMPLATE.md, which outlines the expectations for submitting a pull request
- Added CONTRIBUTING.md, which outlines the expectations for contributing and resources available for WorldWind Android
- My only additional comment about the CONTRIBUTING.md file is that it does not include the design/coding guidelines that are available in the other WorldWind repositories. My thoughts are to add the CONTRIBUTING.md file as is now, but update it with the design/coding guidelines later.
  • Loading branch information
eirizarry authored and pdavidc committed Aug 17, 2017
1 parent 98a363d commit 765863f
Show file tree
Hide file tree
Showing 3 changed files with 143 additions and 0 deletions.
97 changes: 97 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,97 @@
# Contributing to WorldWind Android

#### Table of Contents

[Asking Questions](#asking-questions)

[Contributing](#contributing)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting New Features](#suggesting-new-features)
- [Pull Requests](#pull-requests)

[Resources](#resources)

## Asking Questions

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

- Check out the [WorldWind Forum](https://forum.worldwindcentral.com/)
- Email the [Administrative Contact](mailto:patrick.hogan@nasa.gov)

## 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**](https://forum.worldwindcentral.com/forum/worldwind-android-wwa/android-discussion).
* Check this repository's [**issues**](https://github.com/NASAWorldWind/WorldWindAndroid/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](https://guides.github.com/features/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](ISSUE_TEMPLATE.md).

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](https://github.com/NASAWorldWind/WorldWindAndroid/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](ISSUE_TEMPLATE.md), 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](https://guides.github.com/features/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](PULL_REQUEST_TEMPLATE.md).
* 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: [patrick.hogan@nasa.gov](mailto:patrick.hogan@nasa.gov).
34 changes: 34 additions & 0 deletions ISSUE_TEMPLATE.md
@@ -0,0 +1,34 @@
**Note:** Any issue that does not include enough information to be reviewed in a timely manner may be closed at the
maintainer's discretion.

### Prerequisites

Please fulfill the following requirements before submitting an issue to this repository.

- Check the "Common Problems" page on the WorldWind website: https://worldwind.arc.nasa.gov/web/tutorials/common-problems/
- Check that your issue isn't already filed: https://github.com/NASAWorldWind/WebWorldWind/issues
- Check the WorldWind forum for common solutions: https://forum.worldwindcentral.com/forum/web-world-wind/web-world-wind-help

### Description

[Description of the issue]

### Steps to Reproduce

1. [First step]
2. [Second step]
3. [and so on...]

**Expected behavior:** [What you expect to happen]

**Actual behavior:** [What actually happens]

**Reproduces how often:** [What percentage of the time does it reproduce?]

### Operating System and Version

[What operating system and version are you using?]

### Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.
12 changes: 12 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
**Note:** Filling out this template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the
maintainer's discretion.

### Description of the Change

### Why Should This Be In Core?

### Benefits

### Potential Drawbacks

### Applicable Issues

0 comments on commit 765863f

Please sign in to comment.