Welcome to the Nuvolaris project.
This is an ongoing project, that is still in early stages, to build an Open Source distribution of Apache OpenWhisk licensed released under the Apache Licence 2.0 (like OpenWhisk itself)
There are currently no releases yet. Our first release is scheduled for January 2022.
Too lazy to read?
If you want to contribute, YOU HAVE TO PUT YOUR CODE UNDER A LICENSE. Quick way to to it:
- fork the repository where you want to contribute.
If in doubt which one, fork nuvolaris we move the code in the right place
- clone the repository and open it with VSCode
# change here your-github-user and nuvolaris-submodule
git clone https://github.com/your-github-user/nuvolaris-submodule
cd nuvolaris-submodule
code .
Now it will ask if you want to run in a container. Say yes.
- Add your code and LICENSE IT. Use
license-eye.
After editing, open the terminal and type:
license-eye header fix
- Commit, push and send a pull request to us.
We want to build a complete distribution of a serverless environment that is:
- it is easy to install and manage
- potentially runs in every Kubernetes, but it works on a tested set
- includes a good set of integrated services
This is the main differentiation from Apache OpenWHisk as it only provides a basic engine for serverless. Our goals are described in our roadmap document to read about.
If you want to help here is how:
Do you want to help?
- Start introducing yourself in the forum and partecipating to discussions.
- Chat with us joining our discord server. Note there is a channel for every repository in the project to discuss specific issues.
We split activities in milestones. We give to them a friendly name and we name milestones after characters the movies of The Matrix franchise.
The current milestone (the first one) is Neo. And of course the milestone to reach to release 1.0 is Matrix.
Future Milestones will be named Trinity, Morpheus, Agent Smith and so on.
To manage the milestones we use GitHub Projects that in turn uses the GitHub Issue Tracker.
In order to contribute to our project:
- Review the Code Contribution rules. In particular we need you sign the Apache CLA (Contributor License) and include the Apache License Header in every file. Also every PR will have to pass the existing tests (there are none yet but there will be).
- Either find an open and unassigned issue, or open one by yourself in the Issue Tracker describing what you want to do.
- Please discuss in the forum and ensure you want to do is approved by the project owners, if you want to be sure your PR will be merged. We can still merge unsolicited PR, but if you do not discuss it before there is some risk that for some reason we may unable to merge it. -
- Get an issue assigned. Seriously.
- Code it!
- Submit a Pull Request and get it merged after the review.