Thank you for deciding to contribute! We're excited to have you on the team 🙌
Below you'll find our guidelines for contributing to further development of this codelab, which is hosted at Angular NYC on GitHub.
This project adheres to the Contributor Covenant Code of Conduct. So that everyone can feel welcome we ask you to please uphold this code should you decide to contribute to this project.
The Angular Codelab has quite a few packages installed; below is a guide to give you an idea of the main ones in use. Feel free to use either NPM or Yarn!
- example: (coming soon 😬)
If you find a bug while going the codelab as a student, you can submit feedback through the blue feedback button in the bottom-right corner.
Please check out the previous comments to ensure this problem hasn't already been reported!
Feedback form submissions are magically converted to GitHub issues.
- Include a clear and descriptive header that summarizes the issue
- Make sure you explain the problem and include any relevant details
- Describe the steps you followed to encounter the issue if you can remember them
- Explain what behavior you expected to see instead
- Feel free to include any suggestions if you have them ✨
Before opening a new issue, please check the existing ones to confirm it isn't on file yet.
If opening an issue, please include:
- A succinct and illustrative title
- A helpful description
- Current and expected behavior
- If a suggestion for improvement, how you think the suggestion can improve the project
- Any other details if necessary like screenshots
If you don't know where to start, try perusing issues marked by help-wanted tags!
If you want to work on something there isn't yet an issue for, consider submitting an issue so that multiple contributers aren't unknowingly working on solving the same problem in parallel.
If you're new to Git check out this awesome free Udacity class by Caroline Buckey and Sarah Spikes 📚
And if you're new to just GitHub check out this cool tutorial series by Kent C. Dodds 📝
- Don't forget to pull from the master branch and resolve any merge conflicts first!
- If you don't have access to the repo, fork the project and make a PR from there
- Describe what the PR addresses
- Include screenshots and descriptive explanations if necessary
- Use the present tense
- If applicable, reference the issue being resolved
Extended example:
Change bears' entrypoint
This entrypoint ensures that coala discovers
the bears correctly.
It helps not writing more functions inside
``coalib`` for this.
Closes #5861 // this will automatically link it to the issue and close it when merged
You can read more about git commit style here not here
If you are using Intellij/Webstorm:
Settings -> Code Style -> TypeScript -> Spaces Tab -> Check “ES6 import/export braces”
Angular Codelab comes with its own linter settings. If you're not sure your linter is picking up on them, please run ng lint and fix any styling errors before submitting.