Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 3.69 KB

contributing.md

File metadata and controls

84 lines (57 loc) · 3.69 KB
Raw

Thank you for taking time to contribute. We really appreciate your help.

Contribution guidelines

Awesome lists are a curation, not a collection. We want to make it easier for students to find additional learning resources in the context of this scholarship. Quality matters and not quantity. This is why we cannot accept every submission. However, we are always open for feedback to ensure a certain level of awesomeness 😉

but what is awesome?

Awesome = Community

Here are some things that we consider as an awesome resource:

  • highly recommended by other contributors or fellow students
  • hard to find for various reasons
  • helpful if you struggle with a concept by a different way of teaching
  • you wish you had known this resource when you started taking this course

Since the selection process is community-driven, you will get GitHub reactions from others for your submission. This gives you a way to find out if you are on the right track.

Contributing

Please submit a pull request (PR) or create an issue to add something to the list.

Submissions via pull requests are highly recommended. It may be daunting if you are new to Git and/or GitHub. However the use of these tools is an important skill for any developer. Need help getting started? Click here!

Quality standards for issues and PRs

  • Make sure it has not already been submitted or declined
  • Submission must be in English
  • Check for proper spelling and grammar
  • Briefly write a description and why it should be added to the list

How to create an issue

  • Proceed to the Issues tab in the top menu
  • Use the comment field for your submission
  • Apply the label Submission to your issue

How to submit a pull request

  1. Create a personal fork of the project on GitHub via the Fork button on the top right.

  2. Clone the fork on your local machine via the terminal command:

git clone  https://github.com/[your_username]/udacity-mws-nd

  1. Make your changes locally.

  2. Make sure to include all modified files in your commit:

git add .
  1. Create a commit for the changes you have made. You are free to change the actual commit message.
git commit -am 'My changes for the awesome list'
  1. Finally push your changes to your fork on GitHub.
git push master
  1. Back to GitHub, create a pull request from your fork to this repository.

A final note

If your submission was successful, feel free to add your name in alphabetical order to the contributors list

Getting started with Git and GitHub

Further reading