https://github.com/edadma/trisc-old1

https://github.com/edadma/trisc-old1

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/edadma/trisc-old1
• Owner: edadma
• License: isc
• Created: 2023-04-17T00:48:30.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-04-17T01:58:34.000Z (over 1 year ago)
• Last Synced: 2023-09-11T05:50:28.364Z (over 1 year ago)
• Language: Scala
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# module-name  

**Badges** 

Optional badges such as npm version, test and build coverage, and so on.

**Summary** 

One- or two-sentence description of what the module does.

## Overview

Optionally, include a section of one or two paragraphs with more high-level 

information on what the module does, what problems it solves, why one would 

use it and how.  Don't just repeat what's in the summary.

## Installation

```

$ npm install module-name

```

## Basic use

General description of how to use the module with basic example.

## API 

Full API documentation.

## Examples

Additional examples here.

## Tests

What tests are included and how to run them. 

## Contributing

This project welcomes contributions from the community. Contributions are

accepted using GitHub pull requests; for more information, see 

[GitHub documentation - Creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

For a good pull request, we ask you provide the following:

1. Include a clear description of your pull request in the description

   with the basic "what" and "why"s for the request.

2. The tests should pass as best as you can. GitHub will automatically run

   the tests as well, to act as a safety net.

3. The pull request should include tests for the change. A new feature should

   have tests for the new feature and bug fixes should include a test that fails

   without the corresponding code change and passes after they are applied.

   The command `npm run test-cov` will generate a `coverage/` folder that

   contains HTML pages of the code coverage, to better understand if everything

   you're adding is being tested.

4. If the pull request is a new feature, please include appropriate documentation 

   in the `README.md` file as well.

5. To help ensure that your code is similar in style to the existing code,

   run the command `npm run lint` and fix any displayed issues.

## Contributors

Names of module "owners" (lead developers) and other developers who 

have contributed.

## License

Link to the license, with a short description of what it is, 

e.g. "MIT" or whatever.