Add instructions, how to develop new feature across multiply repositories and add note about proxy #31
Conversation
developers.adoc
Outdated
|
|
||
| Note, that if you behind proxy, you need to run `sbt` with flags | ||
| [source] | ||
| -Dhttp.proxyHost=<you proxy server> |
Mingun
force-pushed
the
build-instructions
branch
from
d7cc10c to
241b6e1
Compare
developers.adoc
Outdated
| @@ -175,6 +194,55 @@ actually be JavaScript libraries, not Java jars. | |||
| . Go to https://oss.sonatype.org/#stagingRepositories | |||
| . Continue to follow Java runtime publishing instructions | |||
|
|
|||
| == Developing new feature | |||
|
|
|||
| Usually, you will develop new feature in your own fork of sub-project and then | |||
There was a problem hiding this comment.
Just give a link to https://guides.github.com/introduction/flow/ instead of describing how to use git and github.
There was a problem hiding this comment.
Not everyone will spend time reading what they need just to share their little solution with the world. Therefore, there should be specific instructions here. Link also can be provided, but for curious
There was a problem hiding this comment.
Not everyone will spend time reading
These are obvious things. One cannot contribute (one can fork and do what he wants in his own fork, but on the first PR sent without following the flow a PR its author will usually be asked either to follow the flow or to GTFO) on GitHub (and GitLab, and BitBucket) without knowing them. We can expect everyone on GitHub already knowing the flow.
There was a problem hiding this comment.
We can expect everyone on GitHub already knowing the flow.
Why then reference to https://guides.github.com/introduction/flow/ needed? That sentence here just for glue and to justify the need for actions below.
There was a problem hiding this comment.
Would be fine to remove that part completely.
|
This PR adds two separate things: proxy-related info and git workflow-related info.
For now, I propose to split this in two and merge in the proxy part. @Mingun, can I ask you to do an extra PR with that, and remove it from this one? |
|
Yes, I will do it on the weekend |
Mingun
force-pushed
the
build-instructions
branch
from
241b6e1 to
ad1e2bf
Compare
| @@ -175,9 +175,55 @@ actually be JavaScript libraries, not Java jars. | |||
| . Go to https://oss.sonatype.org/#stagingRepositories | |||
| . Continue to follow Java runtime publishing instructions | |||
|
|
|||
| == Developing new feature | |||
|
@Mingun I think this info is very useful for new contributors, especially coming by Hackctoberfest. However, I think the best strategy would be to write a tutorial on contributing to Kaitai on https://dev.to and then we can just reference it here. It may then reach a much more people than being stuck in the docs, which are mostly read by experienced developers. |
Is IMHO just a honeypot to collect high-quality personal data for a certain slice of the society at a cost of a T-shirt. It is very weakly related to stimulating people to contribute to open-source - if the contributions are motivated mostly by getting a T-shirt, they are usually of very low quality. |
|
@KOLANICH hey, I've just got a Hacktoberfest T-shirt few days ago with handy stickers. Sold my cookies cheap. :D |
Mingun
force-pushed
the
build-instructions
branch
from
ad1e2bf to
c908bae
Compare
Documentation changes, that was noted in kaitai-io/kaitai_struct_java_runtime#23 (comment)