fix: cleaning up documentation

2022-08-16 02:57:49 -04:00
parent 23f9be033a
commit 5e352a5fe4
5 changed files with 103 additions and 6 deletions
@@ -0,0 +1,39 @@
+# Contributing
+
+We love your input! 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 Apache License 2.0 Software License
+In short, when you submit code changes, your submissions are understood to be under the same
+[Apache 2.0 License](https://choosealicense.com/licenses/apache-2.0/) that covers the project. Feel free to
+contact the maintainers if that's a concern.
+
+
+## Use a Consistent Coding Style
+
+Code style strictly enforced via eslint and prettier. Ensure your code meets our standards by running 
+`npm run lint --fix` prior to submitting your PR. 
@@ -0,0 +1,20 @@
+
+----
+
+### All Submissions:
+
+Do the checklist before filing an issue:
+
+- [ ] Are you using the latest version of anti-to-html-action?
+- [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome.
+- [ ] Is a color being escaped incorrectly? We use [ansi-to-html](https://github.com/rburns/ansi-to-html) and issues related to color discrepancies should be created there.
+- [ ] Have a usage question? Ask your question on [StackOverflow](http://stackoverflow.com). We use StackOverflow for usage question and GitHub for bugs.
+
+
+None of the above, create a bug report
+------------------------------------------------------------------
+
+Make sure to add **all the information needed to understand the bug** so that someone can help. If the info is missing we'll add the 'Needs more information' label and close the issue until there is enough information.
+
+- [ ] Provide a **minimal code snippet**
+- [ ] Provide a link to a failed workflow, if possible.
@@ -0,0 +1,12 @@
+
+----
+
+### All Submissions:
+
+**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
+
+*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
+
+* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/justinm/ansi-to-html-action/blob/master/.github/CONTRIBUTING.md)
+
+*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*