Contribution

Contribution

Any contributions are welcome.

• Add new feature
• Request new feature
• Bug reporting
• Any bug fixing
• Tweak tiny code fragment
• Add/Fix documents
• etc ...

Merge sequence

1. Branch for the feature

   $ git checkout -b feature/blah-blah-blah

2. Add a new feature

   $ $EDITOR src/docker.rs ...

3. Add unit test(s) for the feature
4. Rebase on the master branch (this repository policy requires fast-forward merge)

   $ git remote add origin git@github.com:idein/docworker
   $ git rebase idein/master

5. Make your PR
6. It's confirmed that passes CI tests
   • Unit tests
   • Long tests
   • Build on Linux
   • Build on Windows
   • Lint check with cargo-fmt
7. Resolve conflicts if exists
8. Add a description of your code change
9. Review request to @Idein/agent-team
10. Wait for a response (or ping)
11. Fix your PR (If you requested changing) and re-request review

If you add an API wrapper

1. Update the supported API list.

   - [ ] /blah-blah-blah
   + [x] /blah-blah-blah
   

2. Add unit test(s) for that feature