This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
The following commit(s) were added to refs/heads/master by this push:
new a837e6add Updates developer docs and removing obsolete content
a837e6add is described below
commit a837e6add1fee99115eb426077f6e62fd406eea2
Author: Richard Zowalla <[email protected]>
AuthorDate: Tue Sep 5 21:22:53 2023 +0200
Updates developer docs and removing obsolete content
---
DEVELOPER.md | 38 ++++++++++++--------------------------
1 file changed, 12 insertions(+), 26 deletions(-)
diff --git a/DEVELOPER.md b/DEVELOPER.md
index 698cec835..007cefab9 100644
--- a/DEVELOPER.md
+++ b/DEVELOPER.md
@@ -96,7 +96,7 @@ and
because they require learning about only an isolated portion of the codebase
and are a relatively small amount of work.
Please use idiomatic Clojure style, as explained in [this Clojure style
guide][clj-SG]. Another useful reference is
-the [Clojure Library Coding Standards][clj-LCS]. Perhaps the most important is
consistenly writing a clear docstring
+the [Clojure Library Coding Standards][clj-LCS]. Perhaps the most important is
consistently writing a clear docstring
for functions, explaining the return value and arguments. As of this writing,
the Storm codebase would benefit from
various style improvements.
@@ -193,9 +193,6 @@ _This section applies to committers only._
**Important: A pull request must first be properly approved before you are
allowed to merge it.**
-Committers that are integrating patches or pull requests should use the
official Apache repository at
-[https://gitbox.apache.org/repos/asf/storm.git](https://gitbox.apache.org/repos/asf/storm.git).
-
#### Via Github
You can use the [Gitbox account linking
utility](https://gitbox.apache.org/setup/) to link your Apache and Github
accounts. This will allow you to merge pull requests using Github's UI.
@@ -249,14 +246,14 @@ To pull in a merge request you should generally follow
the command line instruct
In order to build `storm` you need `python3`, `ruby` and `nodejs`. In order to
avoid an overfull page we don't provide platform/OS specific installation
instructions for those here. Please refer to you platform's/OS' documentation
for support.
-The `ruby` package manager `rvm` and `nodejs` package manager `nvm` are for
convenience and are used in the tests which run on [GitHub
actions](https://github.com/apache/storm/actions). They can be installed using
`curl -L https://get.rvm.io | bash -s stable --autolibs=enabled && source
~/.profile` (see the [rvm installation
instructions](https://github.com/rvm/rvm) for details) and `wget -qO-
https://raw.githubusercontent.com/creationix/nvm/v0.26.1/install.sh | bash &&
source ~/.bashrc` [...]
+The `ruby` version manager `rvm` and `nodejs` version manager `nvm` are for
convenience and are used in the tests which run on [GitHub
actions](https://github.com/apache/storm/actions). They can be installed using
`curl -L https://get.rvm.io | bash -s stable --autolibs=enabled && source
~/.profile` (see the [rvm installation
instructions](https://github.com/rvm/rvm) for details) and `wget -qO-
https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash &&
source ~/.bashrc` (se [...]
With `rvm` and `nvm` installed you can run
```sh
-rvm use 2.4.2 --install
-nvm install 8.9.3
-nvm use 8.9.3
+rvm use 2.7 --install
+nvm install 16
+nvm use 16
```
in order to get started as fast as possible. Users can still install a
specific version of `ruby` and/or `node` manually.
@@ -264,7 +261,7 @@ in order to get started as fast as possible. Users can
still install a specific
You will also need the
[mock](https://docs.python.org/3/library/unittest.mock.html)
python testing library (as well as [Python
3.x](https://github.com/pyenv/pyenv)).
With [pip3](https://pip.pypa.io/en/stable/installation/) installed you can run
-(python 2.7.x is not supported).
+(Note: python 2.7.x is **not** supported).
```
pip3 install mock
```
@@ -315,7 +312,7 @@ You can also run tests selectively with
`-Dtest=<test_name>`. This works for bo
Unfortunately you might experience failures in clojure tests which are wrapped
in the `maven-clojure-plugin` and thus doesn't provide too much useful output
at first sight - you might end up with a maven test failure with an error
message as unhelpful as `Clojure failed.`. In this case it's recommended to
look into `target/test-reports` of the failed project to see what actual tests
have failed or scroll through the maven output looking for obvious issues like
missing binaries.
-By default integration tests are not run in the test phase. To run Java and
Clojure integration tests you must enable the profile `integration-tests-only`,
or `all-tests`.
+By default, integration tests are not run in the test phase. To run Java and
Clojure integration tests you must enable the profile `integration-tests-only`,
or `all-tests`.
## Listing dependency licenses
@@ -374,7 +371,7 @@ You can verify whether the digital signatures match their
corresponding files:
## Testing
Tests should never rely on timing in order to pass. Storm can properly test
functionality that depends on time by
-simulating time, which means we do not have to worry about e.g. random delays
failing our tests indeterministically.
+simulating time, which means we do not have to worry about e.g. random delays
failing our tests non-deterministically.
If you are testing topologies that do not do full tuple acking, then you
should be testing using the "tracked
topologies" utilities in `org.apache.storm.testing.clj`. For example,
@@ -417,34 +414,23 @@ repository associated with Storm.
user ID and password, i.e. the credentials you configured via
[https://id.apache.org/](https://id.apache.org/) after
you were [onboarded as a
committer](http://www.apache.org/dev/new-committers-guide.html#account-creation).
* **Everybody else:**
- [https://github.com/apache/storm/](https://github.com/apache/storm/) is a
read-only mirror of the
- official git repository. If you are not a Storm committer (most people)
this is the repository you should work
- against. See _Development workflow_ above on how you can create a pull
request, for instance.
-
-An automated bot (called _[ASF GitHub
Bot](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=githubbot)_ in
-[Storm JIRA](https://issues.apache.org/jira/browse/STORM)) runs periodically
to merge changes in the
-[official Apache repo](https://gitbox.apache.org/repos/asf/storm.git) to the
read-only
-[GitHub mirror repository](https://github.com/apache/storm/), and to merge
comments in GitHub pull requests to
-the [Storm JIRA](https://issues.apache.org/jira/browse/STORM).
-
+ [https://github.com/apache/storm/](https://github.com/apache/storm/) is a
mirror of the
+ ASF git repository. If you are not a Storm committer (most people) this is
the repository you should work
+ against. See _Development workflow_ above on how you can create a pull
request, for instance.
<a name="issue-tracking"></a>
## Issue tracking (JIRA)
Issue tracking includes tasks such as reporting bugs, requesting and
collaborating on new features, and administrative
-activities for release management. As an Apache software project we use JIRA
as our issue tracking tool.
+activities for release management. As an Apache software project we use JIRA
as our issue tracking tool.
The Storm JIRA is available at:
*
[https://issues.apache.org/jira/browse/STORM](https://issues.apache.org/jira/browse/STORM)
-
If you do not have a JIRA account yet, then you can create one via the link
above (registration is free).
-<a name="code-search"></a>
-The storm codebase is available at
[Codota](https://www.codota.com/xref/#/github_apache_storm_560da9ada8cb8703008bbfdc/findUsages)
where you can semantically search it like in an IDE (e.g. find usages for a
method).
-
<a name="questions"></a>
# Questions?
