Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions CONTRIBUTING-GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing to my CODEDOC blog
We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## We Develop with Github
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [_**Github Flow**_](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:

1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/coder-lg-/coder-lg-blog-codedoc/issues)
We use GitHub issues to track public bugs. Report a bug by [_**opening a new issue**_](https://github.com/coder-lg-/coder-lg-blog-codedoc/issues/new) and choosing a template(`bug`/`feature request`); it's that easy!

## Write bug reports with detail, background, and sample code

**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People *love* thorough bug reports. It helps the maintainer pinpoint to the specific file _causing_ the bug.

## License
By contributing, you agree that your contributions will be licensed under the MIT License.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DevOps
# credits to [`@TysonMN`](https://GitHub.com/TysonMN) for the blog!

## Essential

Expand Down Expand Up @@ -59,8 +59,8 @@ Support for comments on posts is powered by utterances.  The comments are store

### GitHub

Of course GitHub also plays a crucial role.  In addition to hosting the comments in select issues, all the content is committed into this repo. The website is redeployed shortly after `master` is updated.
Of course GitHub also plays a crucial role.  In addition to hosting the comments in select issues, all the content is committed into this repo. The website is redeployed shortly after I activate my non-commited batch file that has a curl command to send a request. Useful for `suspense`

# Improvements?

Is there some improvement that you would like to see in my blog?  You can tell me about it by [creating an issue](https://github.com/TysonMN/tyson-williams-blog/issues/new) or you can make the improvement yourself and then send me a [pull request](https://github.com/TysonMN/tyson-williams-blog/compare).
Is there some improvement that you would like to see in my blog?  You can tell me about it by [creating an issue](https://github.com/coder-lg/coder-lg-blog-codedoc/issues/new) or you can make the improvement yourself and then send me a [pull request](https://github.com/coder-lg-blog-codedoc/compare).