8000 GitHub - tevissaur/README-generator
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

tevissaur/README-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README Generator

This script allows the user to answer prompts given by the computer and have it generate a well formatted README file.

Table of Contents

Technologies Used

  • JavaScript
  • NodeJS

Installation

  • Clone to machine
  • Run node index.js to run script.

Usage

  1. Open the terminal in the location you cloned it to
  2. Run necessary commands
  3. Answer all prompts

Contributing

Bug Reports

  • Ensure your issue [has not already been reported]. It may already be fixed!
  • Include the steps you carried out to produce the problem.
  • Include the behavior you observed along with the behavior you expected, and why you expected it.
  • Include any relevant stack traces or debugging output.

Feature Requests

We welcome feedback with or without pull requests. If you have an idea for how to improve the project, great! All we ask is that you take the time to write a clear and concise explanation of what need you are trying to solve. If you have thoughts on how it can be solved, include those too!

The best way to see a feature added, however, is to submit a pull request.

Pull Requests

  • Before creating your pull request, it's usually worth asking if the code you're planning on writing will actually be considered for merging. You can do this by [opening an issue] and asking. It may also help give the maintainers context for when the time comes to review your code.

  • Ensure your [commit messages are well-written]. This can double as your pull request message, so it pays to take the time to write a clear message.

  • Add tests for your feature. You should be able to look at other tests for examples. If you're unsure, don't hesitate to [open an issue] and ask!

  • Submit your pull request!

Support Requests

For security reasons, any communication referencing support tickets for Coinbase products will be ignored. The request will have its content redacted and will be locked to prevent further discussion.

Tests

Coming soon...

Contact Me

If you have any questions. You can reach me at my Github or you can email me at: tevisreilly1@gmail.com.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0