Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise markdown formatting #37

Merged
merged 1 commit into from
Apr 1, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ assignees: ''

Please describe the bug that was encountered.
Please provide as much detail as possible, covering things such as:
- The `build-avr-gcc` version (Git commit SHA)
- The build-avr-gcc version (Git commit SHA)
- Description of expected behavior, and observed behavior
- Relevant code and steps required to reproduce the bug

Expand Down
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Contributing to build-avr-gcc
The following is a set of guidelines for contributing to `build-avr-gcc`.

The following is a set of guidelines for contributing to build-avr-gcc.
Note that these are guidelines, not rules.
Use your best judgment.

# Contents

- [I have a question](#i-have-a-question)
- [How can I contribute](#how-can-i-contribute)
- [Report a bug](#report-a-bug)
Expand All @@ -18,6 +20,7 @@ Use your best judgment.
- [Style-guide](#style-guide)

# I have a question

If you have a question, please review the relevant project documentation, and
search/browse existing issues and discussions.
If you have not found an answer to your question after reviewing the relevant project
Expand All @@ -27,17 +30,19 @@ discussion to ask your question.
# How can I contribute

## Report a bug

To report a bug, please use the `bug` issue template to open an issue that details the bug
that was encountered.
Please provide as much detail as possible, covering things such as:
- The `build-avr-gcc` version (Git commit SHA)
- The build-avr-gcc version (Git commit SHA)
- Description of expected behavior, and observed behavior
- Relevant code and steps required to reproduce the bug

If the bug report can be verified, the changes required to fix the bug will be captured in
the issue in preparation for implementing the bug fix.

## Implement a bug fix

Issues for implementing bug fixes can be found by looking for issues with the `type-bug`
type label and `status-awaiting_development` status label.
To implement a bug fix, please open a draft pull request that references the associated
Expand All @@ -48,6 +53,7 @@ If changes are requested, please discuss and/or address the review findings befo
requesting a new review.

## Request an enhancement to an existing feature

To request an enhancement to an existing feature, please use the `enhancement-request`
issue template to open an issue that details the desired enhancement.
Please provide as much detail as possible, covering things such as:
Expand All @@ -58,6 +64,7 @@ If the request for the enhancement to the existing feature is accepted, issue(s)
designing or implementing the enhancement will be created as appropriate.

## Design an enhancement to an existing feature

To design an enhancement to an existing feature, please use the `enhancement-design` issue
template to open an issue that details the design.
Please provide as much detail as possible, covering things such as:
Expand All @@ -70,6 +77,7 @@ If the design for the enhancement to the existing feature is accepted, issue(s)
implementing the enhancement will be created.

## Implement an enhancement to an existing feature

Issues for implementing enhancements to existing features can be found by looking for
issues with the `type-enhancement` type label and `status-awaiting_development` status
label.
Expand All @@ -81,6 +89,7 @@ If changes are requested, please discuss and/or address the review findings befo
requesting a new review.

## Request a new feature

To request a new feature, please use the `feature-request` issue template to open an issue
that details the desired new feature.
Please provide as much detail as possible, covering things such as:
Expand All @@ -91,6 +100,7 @@ If the request for the new feature is accepted, issue(s) for designing or implem
feature will be created as appropriate.

## Design a new feature

To design a new feature, please use the `feature-design` issue template to open an issue
that details the design.
Please provide as much detail as possible, covering things such as:
Expand All @@ -103,6 +113,7 @@ If the design for the new feature is accepted, issue(s) for implementing the fea
be created.

## Implement a new feature

Issues for implementing a new feature can be found by looking for issues with the
`type-feature` type label and `status-awaiting_development` status label.
To implement a new feature, please open a draft pull request that references the
Expand All @@ -113,6 +124,7 @@ If changes are requested, please discuss and/or address the review findings befo
requesting a new review.

## Perform a refactoring

Issues for performing a refactoring can be found by looking for issues with the
`type-refactoring` type label and `status-awaiting_development` status label.
To perform a refactoring, please open a draft pull request that references the associated
Expand All @@ -123,6 +135,7 @@ If changes are requested, please discuss and/or address the review findings befo
requesting a new review.

# Style guide

Formatting for all source code and content is neither automated nor documented (with the
exception of a column limit) at this time.
Please use a column limit of 90 for source code and content.
Expand Down
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# build-avr-gcc

[![CI](https://github.com/apcountryman/build-avr-gcc/actions/workflows/ci.yml/badge.svg)](https://github.com/apcountryman/build-avr-gcc/actions/workflows/ci.yml)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)

`avr-gcc` build script.

## Obtaining the Source Code

HTTPS:
```shell
git clone https://github.com/apcountryman/build-avr-gcc.git
Expand All @@ -15,41 +17,49 @@ git clone git@github.com:apcountryman/build-avr-gcc.git
```

## Usage
See the `avr-gcc` build script's help text and device family packs install script's help
text for usage details.

See the `build-avr-gcc` and `install-device-family-pack` scripts' help text for usage
details.
```shell
./build-avr-gcc --help
./install-device-family-packs --help
```

## Versioning
Post version 0.1.0, `build-avr-gcc` will follow the [Abseil Live at Head

Post version 0.1.0, build-avr-gcc will follow the [Abseil Live at Head
philosophy](https://abseil.io/about/philosophy).

## Workflow
`build-avr-gcc` uses the [GitHub flow](https://guides.github.com/introduction/flow/)

build-avr-gcc uses the [GitHub flow](https://guides.github.com/introduction/flow/)
workflow.

## Git Hooks

To install this repository's Git hooks, run the `install` script located in the
`git/hooks` directory.
See the script's help text for usage details.
See the `install` script's help text for usage details.
```shell
$ ./git/hooks/install --help
```

## Code of Conduct
`build-avr-gcc` has adopted the Contributor Covenant 2.0 code of conduct.

build-avr-gcc has adopted the Contributor Covenant 2.0 code of conduct.
For more information, [see the `CODE_OF_CONDUCT.md` file in this
repository](CODE_OF_CONDUCT.md).

## Contributing
If you are interested in contributing to `build-avr-gcc`, please [read the
`CONTRIBUTING.md` file in this repository](CONTRIBUTING.md).

If you are interested in contributing to build-avr-gcc, please [read the `CONTRIBUTING.md`
file in this repository](CONTRIBUTING.md).

## Authors

- Andrew Countryman

## License
`build-avr-gcc` is licensed under the Apache License, Version 2.0.
For more information, [see the LICENSE file in this repository](LICENSE).

build-avr-gcc is licensed under the Apache License, Version 2.0.
For more information, [see the `LICENSE` file in this repository](LICENSE).