Skip to content

Commit a2ae692

Browse files
committed
Update contributing file
1 parent fc1f7ed commit a2ae692

File tree

3 files changed

+27
-7
lines changed

3 files changed

+27
-7
lines changed

.github/CONTRIBUTING

+16-5
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,23 @@ To start using this repository right away,
1313

1414
### How to install it
1515

16-
> Description is not available yet
16+
We have two quick alternatives to start on this project:
17+
- Using [Docker](https://www.docker.com/). There is a *Dockerfile* specified at the root directory.
18+
- Using [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). There is a *devcontainer.json* in *.devcontainer/* directory.
19+
20+
### Releasing
21+
22+
To create a new release version, follow these steps:
23+
- Update the version in the *pom.xml* (via pull request or direct commit)
24+
- Start the [Create a new release](https://github.com/gfarfanb/jurl/releases/new) form
25+
- Download the *jurl-\*.jar* file that matches with the generated version from [packages](https://github.com/gfarfanb/jurl/packages/2238375)
26+
- Zip the *jurl-\*.jar* file plus the *jurl* (bash file) and *jurl.bat* located at the root directory
27+
- Edit the generated release by attaching the ZIP file with the *jurl-\*.jar* and scripts
1728

1829
## Copyright
1930

20-
*jurl* core is licensed under [MIT License][mit_license], with a few exceptions
21-
in bundled classes. We consider all contributions as [MIT][mit_license] unless
22-
it's explicitly stated otherwise. [MIT][mit_license]-incompatible code contributions
23-
will be rejected. Contributions under [MIT][mit_license]-compatible licenses
31+
*jurl* core is licensed under [MIT License](../LICENSE), with a few exceptions
32+
in bundled classes. We consider all contributions as *MIT* unless
33+
it's explicitly stated otherwise. *MIT-incompatible* code contributions
34+
will be rejected. Contributions under *MIT-compatible* licenses
2435
may be also rejected if they are not ultimately necessary.

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Giovanni Farfán B.
3+
Copyright (c) 2023-2024 Giovanni Farfán B.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
[![jurl CI](https://github.com/gfarfanb/jurl/actions/workflows/maven.yml/badge.svg)](https://github.com/gfarfanb/jurl/actions/workflows/maven.yml)
22

33
# jurl
4-
CLI Java application to provides an API test/client tool.
4+
CLI Java application to provide an API test/client tool.
55

66
**config.json**
77
```json
88
{
99
"openEditorCommand": "\"C:\\Program Files\\Sublime Text\\subl.exe\" \"{{~win-separator~HTTP/response.path}}\""
1010
}
1111
```
12+
13+
## Contribution
14+
15+
Follow the [Contribution guidelines](.github/CONTRIBUTING) for this project.
16+
17+
## License
18+
19+
Copyright © 2023-2024, [Giovanni Farfán B.](https://github.com/gfarfanb). Released under the
20+
[MIT License](./LICENSE).

0 commit comments

Comments
 (0)