diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c1b89b7f1 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 + + diff --git a/README.md b/README.md index 9c10a3db8..aa763a7a4 100644 --- a/README.md +++ b/README.md @@ -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