forked from liquidmetal-dev/flintlock
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Basic structure for README.md and CONTRIBUTING.md
* Outline README.md * Basic information in CONTRIBUTING.md fixes liquidmetal-dev#82
- Loading branch information
Showing
2 changed files
with
74 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Contributing | ||
|
||
We highly value and encourage contributions from the community! | ||
|
||
Reignite is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub | ||
Pull Requests.This document outlines some of the conventions on development | ||
workflow, commit message formatting, contact points and other resources to make | ||
it easier to get your contribution accepted. | ||
|
||
We gratefully welcome improvements to documentation as well as to code. | ||
|
||
## Guidelines | ||
|
||
If you have a feature suggestion or found a bug, head over to | ||
[GitHub issues][issues] and see if there's an open issue matching your | ||
description. If not feel free to open a new issue and add short description: | ||
- In case of a bug, be sure to include the steps you performed and what | ||
- Reignite responded so it's easy for others to reproduce If you have a | ||
- feature suggestion, describe it in moderate detail and include some | ||
- potential uses you see for the feature. | ||
We prioritize the features to be implemented based on their | ||
usefulness/popularity. Of course if you want to start contributing yourself, | ||
go ahead! We'll be more than happy to review your pull requests. | ||
|
||
The maintainers will add the correct labels/milestones to the issue for you. | ||
|
||
[issues]: https://github.com/weaveworks/reignite/issues | ||
|
||
### Contributing your code | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# reignite - the spawn of ignite | ||
(Re)Ignite a MicroVM | ||
# (Re)Ignite a MicroVM | ||
|
||
## What is (Re)Ignite? | ||
|
||
## Use-cases | ||
|
||
## Documentation | ||
|
||
* [Getting started with reignite][quickstart] | ||
|
||
## Contributing | ||
|
||
Please see [CONTRIBUTING.md][contrib] and our [Code Of Conduct][coc]. | ||
|
||
Please see CONTRIBUTING.md and our Code Of Conduct. | ||
|
||
Other interesting resources include: | ||
|
||
* [The issue tracker][issues] | ||
* [The list of milestones][milestones] | ||
* [Architectural Decision Records (ADR)][adr] | ||
* [Getting started with reignite][quickstart] | ||
|
||
## Getting Help | ||
|
||
If you have any questions about, feedback for or problems with ignite: | ||
|
||
* [File an issue][issues]. | ||
|
||
Your feedback is always welcome! | ||
|
||
## License | ||
|
||
[License 2.0][license] | ||
|
||
|
||
[quickstart]: https://github.com/weaveworks/reignite/blob/main/docs/quick-start.md | ||
[contrib]: https://github.com/weaveworks/reignite/blob/main/CONTRIBUTING.md | ||
[coc]: https://github.com/weaveworks/reignite/blob/main/CODE_OF_CONDUCT.md | ||
[issues]: https://github.com/weaveworks/reignite/issues | ||
[milestones]: https://github.com/weaveworks/reignite/milestones | ||
[adr]: https://github.com/weaveworks/reignite/tree/main/docs/adr | ||
[license]: https://github.com/weaveworks/reignite/blob/main/LICENSE |