mirror of
https://github.com/Orange-OpenSource/hurl.git
synced 2024-09-17 08:47:44 +03:00
Update contributong guide.
This commit is contained in:
parent
e9a92fa9f5
commit
176bff3fa5
@ -4,36 +4,39 @@ Thank you for investing time in our project!
|
|||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
|
|
||||||
Whether you have discovered a bug, want a new feature in Hurl, or change code, [please fill an issue] before any PR.
|
Whether you have discovered a bug, want a new feature in Hurl, or change code, [please fill an issue] or [start a discussion]
|
||||||
We like to discuss things before implementation and want to be sure that:
|
before any PR. We like to discuss things before implementation and want to be sure that:
|
||||||
|
|
||||||
- Any new features are coherent with Hurl core values
|
- Any new features are coherent with [Hurl core values].
|
||||||
- You don't waste time on a feature that will not fit Hurl
|
- You don't waste time on a feature that will not fit Hurl.
|
||||||
- All options have been considered if possible
|
- All options have been considered if possible.
|
||||||
- We try to minimize dependencies and import new crates parsimoniously
|
- We try to minimize dependencies and import new crates parsimoniously.
|
||||||
|
|
||||||
## Pull Requests
|
We really want to be focused and consider any new features carefully before committing to it. A new idea can be really
|
||||||
|
relevant to you and we understand it; that's said, we try to reflect on every aspect (maintainability, feature fitting with future evolutions etc...). Don't be too harsh on us if we postpone your proposal, it's for the sake of Hurl!
|
||||||
- [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository). Don't use `master` branch for PR.
|
|
||||||
- All Git commits are required to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) to be marked as "Verified": signed with a GPG, SSH, or S/MIME that is successfully verified by GitHub. For changing a single commit after creating the PR, use `git commit -S --amend` and force push the branch.
|
|
||||||
- All tests must be green before merge.
|
|
||||||
- Hurl git history is linear, so we ask to rebase your PR before final merge.
|
|
||||||
|
|
||||||
## Hurl Core Values
|
## Hurl Core Values
|
||||||
|
|
||||||
- Hurl is a first class citizen CLI tool, fast and reliable
|
- Hurl is a first class citizen CLI tool, fast and reliable.
|
||||||
- Hurl is a cherry on the top of curl. What you can do with curl, you could do it with Hurl
|
- Hurl is a cherry on the top of curl. What you can do with curl, you could do it with Hurl.
|
||||||
- Hurl file format is text plain, loosely based on HTTP
|
- Hurl file format is text plain, loosely based on HTTP.
|
||||||
- Hurl is multiplatform, working on Linux, macOS, Windows
|
- Hurl is multiplatform, working on Linux, macOS, Windows.
|
||||||
|
|
||||||
## How Can You Help ?
|
## How Can You Help ?
|
||||||
|
|
||||||
- Installing / Packet managers: bundle Hurl for a particular packet manager is welcome. Currently, we built binaries for
|
- Installing / Packet managers: bundle Hurl for a particular packet manager is welcome. Currently, we built binaries for
|
||||||
Linux, macOS, Windows and we support a narrow set of packet manager. [More would be better!]
|
Linux, macOS, Windows and we support a narrow set of packet manager. [More would be better!].
|
||||||
- IDE Support: everything from color syntax (in VSCode, Vim, IntelliJ, TextMate etc...) would be a good idea. An
|
- IDE Support: everything from color syntax (in VSCode, Vim, IntelliJ, TextMate etc...) would be a good idea. An
|
||||||
integrated way to run Hurl file would be cool also
|
integrated way to run Hurl file would be cool also.
|
||||||
- [Documentation] is a never finished work and could be always improve. Don't hesitate to clarify, fix typos etc...
|
- [Documentation] is a never finished work and could be always improved. Don't hesitate to clarify, even fix typos etc...
|
||||||
- Report bugs: if possible some simple repro steps with the Hurl version, name of the platform etc...
|
- Report bugs: if possible some simple repro steps with `hurl --version`, name of the platform etc... PR for bugs fixes are really appreciated. If there is [an integration test] that complement it, it's the cherry on the cake.
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
|
||||||
|
- [Create a new Git branch], don't use `master` branch for PR.
|
||||||
|
- All Git commits are [required to be signed] and marked as "Verified": signed with a GPG, SSH, or S/MIME that is successfully verified by GitHub.
|
||||||
|
- All tests must be green before merge. Our CI/CD will run [a test suite] to insure everything is OK.
|
||||||
|
- Hurl Git history is linear, so we may rebase your PR on your fork before final merge.
|
||||||
|
|
||||||
## Build and Test
|
## Build and Test
|
||||||
|
|
||||||
@ -87,9 +90,15 @@ Et voilà 🎉!
|
|||||||
|
|
||||||
|
|
||||||
[please fill an issue]: https://github.com/Orange-OpenSource/hurl/issues
|
[please fill an issue]: https://github.com/Orange-OpenSource/hurl/issues
|
||||||
|
[start a discussion]: https://github.com/Orange-OpenSource/hurl/discussions
|
||||||
[More would be better!]: https://hurl.dev/docs/installation.html
|
[More would be better!]: https://hurl.dev/docs/installation.html
|
||||||
[Documentation]: https://github.com/BurntSushi/ripgrep#installation
|
[Documentation]: https://hurl.dev
|
||||||
[Hurl build documentation]: https://hurl.dev/docs/installation.html#building-from-sources
|
[Hurl build documentation]: https://hurl.dev/docs/installation.html#building-from-sources
|
||||||
[`bin/test/test_prerequisites.sh`]: /bin/test/test_prerequisites.sh
|
[`bin/test/test_prerequisites.sh`]: /bin/test/test_prerequisites.sh
|
||||||
[`bin/test/test_prerequisites.ps1`]: /bin/test/test_prerequisites.ps1
|
[`bin/test/test_prerequisites.ps1`]: /bin/test/test_prerequisites.ps1
|
||||||
[virtual environment]: https://docs.python.org/3/tutorial/venv.html
|
[virtual environment]: https://docs.python.org/3/tutorial/venv.html
|
||||||
|
[Hurl core values]: #hurl-core-values
|
||||||
|
[a test suite]: https://github.com/Orange-OpenSource/hurl/actions
|
||||||
|
[an integration test]: https://github.com/Orange-OpenSource/hurl/tree/master/integration/tests_ok
|
||||||
|
[Create a new Git branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository
|
||||||
|
[required to be signed]: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification
|
Loading…
Reference in New Issue
Block a user