forked from rohit-lakhanpal/ai-hackathon-starter-kit
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dab271b
commit 4fd869a
Showing
3 changed files
with
129 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## PR Summary | ||
|
||
<!-- summarize your PR between here and the checklist --> | ||
|
||
## PR Checklist | ||
|
||
- [ ] PR has a meaningful title | ||
- [ ] Summarized changes | ||
- [ ] Change is not breaking | ||
- [ ] This PR is ready to merge and is not **Work in Progress** | ||
- **Code changes** | ||
- [ ] Link to a filed issue | ||
- [ ] [Change log](https://github.com/rohit-lakhanpal/ai-hackathon-starter-kit/blob/main/CHANGELOG.md) has been updated with change under unreleased section |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Change log | ||
|
||
All notable changes to this kit will be documented in this file. | ||
|
||
- Uses [semantic versioning](http://semver.org/) to declare changes. | ||
|
||
Continue reading to see the changes included in the latest version. | ||
|
||
## Unreleased | ||
- Readme updates | ||
- Engineering changes to include Contributing and version changes | ||
|
||
## v0.1.0 | ||
- Initial preview release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Contributing to AI Hackathon Starter Kit | ||
Welcome, and thank you for your interest in contributing to AI Hackathon Starter Kit! | ||
|
||
There are many ways in which you can contribute, beyond writing code. | ||
The goal of this document is to provide a high-level overview of how you can get involved. | ||
|
||
- [Reporting issues](#reporting-issues) | ||
- Fix bugs or add features | ||
|
||
## Contributor License Agreement (CLA) | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to | ||
agree to a Contributor License Agreement (CLA) declaring that you have the right to, | ||
and actually do, grant us the rights to use your contribution. For details, visit | ||
https://cla.microsoft.com. | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need | ||
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the | ||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA. | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
||
## Reporting issues | ||
|
||
Have you identified a reproducible problem? | ||
Have a feature request? | ||
We want to hear about it! | ||
Here's how you can make reporting your issue as effective as possible. | ||
|
||
### Look for an existing issue | ||
|
||
Before you create a new issue, please do a search in [open issues][issues] to see if the issue or feature request has already been filed. | ||
|
||
If you find your issue already exists, | ||
make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). | ||
Use a reaction in place of a "+1" comment: | ||
|
||
* 👍 - upvote | ||
|
||
## Contributing to code | ||
|
||
- Before writing a fix or feature enhancement, ensure that an issue is logged. | ||
- Be prepared to discuss a feature and take feedback. | ||
- Include unit tests and updates documentation to complement the change. | ||
|
||
When you are ready to contribute a fix or feature: | ||
|
||
- Start by [forking the ai-hackathon-starter-kit][github-fork]. | ||
- Create a new branch from main in your fork. | ||
- Add commits in your branch. | ||
- If you have updated module code or rules also update `CHANGELOG.md`. | ||
- You don't need to update the `CHANGELOG.md` for changes to unit tests or documentation. | ||
- Try building your changes locally. See [building from source][build] for instructions. | ||
- [Create a pull request][github-pr-create] to merge changes into the PSDocs `main` branch. | ||
- If you are _ready_ for your changes to be reviewed create a _pull request_. | ||
- If you are _not ready_ for your changes to be reviewed, create a _draft pull request_. | ||
- An continuous integration (CI) process will automatically build your changes. | ||
- You changes must build successfully to be merged. | ||
- If you have any build errors, push new commits to your branch. | ||
- Avoid using forced pushes or squashing changes while in review, as this makes reviewing your changes harder. | ||
|
||
### Intro to Git and GitHub | ||
|
||
When contributing to documentation or code changes, you'll need to have a GitHub account and a basic understanding of Git. | ||
Check out the links below to get started. | ||
|
||
- Make sure you have a [GitHub account][github-signup]. | ||
- GitHub Help: | ||
- [Git and GitHub learning resources][learn-git]. | ||
- [GitHub Flow Guide][github-flow]. | ||
- [Fork a repo][github-fork]. | ||
- [About Pull Requests][github-pr]. | ||
|
||
### Code editor | ||
|
||
You should use the multi-platform [Visual Studio Code][vscode] (VS Code). | ||
The project contains a number of workspace specific settings that make it easier to author consistently. | ||
|
||
### Building and testing | ||
|
||
When creating a pull request to merge your changes, a continuous integration (CI) pipeline is run. | ||
The CI pipeline will build then test your changes across MacOS, Linux and Windows configurations. | ||
|
||
Before opening a pull request try building your changes locally. | ||
|
||
## Thank You! | ||
|
||
Your contributions to open source, large or small, make great projects like this possible. | ||
Thank you for taking the time to contribute. | ||
|
||
[learn-git]: https://help.github.com/en/articles/git-and-github-learning-resources | ||
[github-flow]: https://guides.github.com/introduction/flow/ | ||
[github-signup]: https://github.com/signup/free | ||
[github-fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo | ||
[github-pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests | ||
[github-pr-create]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork | ||
[vscode]: https://code.visualstudio.com/ | ||
[issues]: https://github.com/Microsoft/PSDocs-vscode/issues |