So if you're here, it's most likely because you want to contribute to Octopilot. Thanks!
First, if you're not sure of how to proceed, or need some help, you should start with opening an issue to start a discussion.
If you're new to GitHub and/or open-source, you should read GitHub's guide on forking a repository.
Note that we're using Git submodules to include a theme for Hugo, so if you want to work on the docs - or at least render them locally - you'll need to either:
- clone the repository with the
--recursiveflag, such as:$ git clone --recursive https://github.com/dailymotion-oss/octopilot.git # or your fork - or if you have already cloned the repository without the
--recursiveflag, you can run:$ git submodule update --init --recursive
The best place to find the exact versions of the tools - Go, Hugo, ... - used is the .github/workflows directory.
- If you want to fix a bug or add a new feature, the best place to start is the ARCHITECTURE.md file.
- If you're adding a new feature, please don't forget the documentation ;-)
- If you're changing an existing feature, please do so in a backward-compatible way if possible.
- If you want to improve the documentation, have a look at the docs/README.md file.
- Please follow the Conventional Commits spec when writing your git commits.
- We're using this spec to generate the next release version, using jx-release-version.
- Add as much details as possible to your commit message and/or pull request.
- In particular, you should explain what you want to achieve, it helps reviewers to understand what you're trying to do and if you are using the right approach.
- Once your pull request will be merged, a new release will be created automatically.
Contributing is not limited to fixing bugs and adding features. If you have a question, a bug report or a feature request, please create an issue.