Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 2.85 KB

contributing.md

File metadata and controls

42 lines (35 loc) · 2.85 KB

Star Verse Contribution

Guidelines

First off, thank you for considering contributing to Star Verse! It's people like you that can help make Star Verse an amazing app! There are no strict guidelines in place to help contribute to making this app better. I've put together a list of ideas below to help you get started, and it should be noted that any developer may contribute and suggest ideas and features. Check out the issue section to see a list of ready-made action targets to take part in. Whether you're a developer just starting out or ready to build the next rocket ship, join in the Star Verse party!

As listed in the readme, any contribution will have you made will be featured in the app alongside this repository.

It is important to note that the API Key used to parse pictures and other information will not be provided by me, but you can follow this NASA API Generator Link and this Astrobin API to generate your keys and plug them into code where necessary.

Please do not publicly display your API Key, store in a different object/class and do not list it in your pull request!

The API code will look like this:

val url = "https://api.nasa.gov/planetary/apod/?api_key=$API_KEY"

Where API_KEY is the variable used to parse the API Key.

List of Ideas for your contribution

  • Convert Strings into another language
  • Upgrade dependencies (and run to make sure the app works!)
  • Go through list of TODOs in various places
  • Make XML activity files more responsive on various screen sizes/lanugages
  • Correct typos and formatting issues
  • Add features and document them

First Time Contributor?

Here are a couple of friendly tutorials to help you make a pull request: http://makeapullrequest.com/ and http://www.firsttimersonly.com/

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Follow these steps to contribute!

  1. Discover issues or suggest something in the Star Verse Issue tab
  2. If you find an issue and wish to work on it, leave a comment and/or extra details on what you're going to do so you can be assigned to the issue.
  3. Wait for approval.
  4. If approved, take to the stars and work out your fix/suggestion/feature. I suggest forking this project and making your changes there.
  5. Assure the app is still running well without crashing or major performance issues.
  6. Create a pull request which will be checked by me for approval or suggestions
  7. If approved, your contribution will be added to the project and you'll be listed as a contributor in the app!