-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Update readme for general audience (#435)
* Update readme for general audience * Fix spelling * Clarify role * Add PR template we use for VCIO * Prettified Code! --------- Co-authored-by: BekahHW <[email protected]>
- Loading branch information
Showing
3 changed files
with
86 additions
and
8 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,45 @@ | ||
## Linked Issue | ||
|
||
<!-- | ||
If you have a pull request related to a current issue please link to that issue number. | ||
That issue can be linked to the pull request by using the side panel in the Github UI or using the `#` symbol followed by the number of the associated issue. | ||
To link a pull request to an issue to show that a fix is in progress and to automatically close the issue when someone merges the pull request, type the keyword "Closes" followed by a reference to the issue. For example, Closes #404 or Closes Virtual-Coffee/virtualcoffee.io/issues/404. | ||
--> | ||
|
||
## Description | ||
|
||
<!-- | ||
A pull request description describes what constitutes the Pull Request and what changes you have made to the code. | ||
It explains what you've done, including any code changes, configuration changes, migrations included, new APIs introduced, changes made to old APIs, any new workers/crons introduced in the system, copy changes, and so on. You get the gist. | ||
A good description informs everyone that is reaading it of the purpose of the pull request. This helps not just the current maintainers but anyone reading it now or in the future to understand your intent. | ||
If the request is not complete but you want feedback use Draft Pull Request option of the Pull request dropdown menu. | ||
@mention individuals that you want to review the PR, and mention why. (“ @username I want to know what you think of this code.”) | ||
--> | ||
|
||
## Methodology | ||
|
||
<!-- | ||
This section explains why the above changes explained were done. | ||
Sometimes a developer feels that it's okay to write "Business/Product requirement" in the description. That's fine, but doing so defeats the purpose of this section. | ||
If there is a better explanation as to why the changes were suggested, it's always good to attach a document reference link for that information. | ||
A good "Why" section should explain the reasoning behind any changes. | ||
--> | ||
|
||
## Code of Conduct | ||
|
||
> By submitting this pull request, you agree to follow our [Code of Conduct](https://virtualcoffee.io/code-of-conduct/) |
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
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