Proposed Apache-Spot Commit Workflow

NOTE: Most of this guide is based on ASF Documentation.

This guide is meant to provide a workflow for committers of Spothreat. The proposed workflow is for using git with apache-spot codebase.Depending the nature of the change two different approaches can be used to commit to Spothreat: Individual Push or Topic Branding.

Individual Push (most commonly used by the community):

Steps:

For the Github repository at https://github.com/spothreat/spot if you haven't already. For more information about Fork please go to: https://help.github.com/articles/fork-a-repo/
Clone your fork, create a new branch named after a Jira issue (i.e. spot-100).
Push commits to your local branch.
Test it!!!
Create a pull request (PR) against the upstream repo (master) of apache-spot. For more information about how to create a pull request please go to: https://help.github.com/articles/about-pull-requests/.
Wait for the maintainers to review your PR.

Topic Branching (upstream)

What are a topic branches?

According to the git definition: "A topic branch is a short-lived branch that you create and use for a single particular feature or related work." (https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches)

Sometimes a new major feature will have dependencies between modules or developers that can't be separated into individual pushes, when this happens, a topic branch will be created to deliver the complete functionality before the merge with the upstream (encapsulated dev enviroment).

In order to create a topic branch, three requirements are needed:

A design document must be uploaded using Jira. This design must be approved by the maintainers.
A voting process will be required to approve the topic branch creation, at least 3 maintainers need to approve it.
A commitment to delete the branch after merging it into the upstream branch must be done. The topic branch should only exist while the work is still in progress.

A meaningful name must be given to the branch. It is recommended to use JIRA issue created with the design document to link the branch.

IMPORTANT: There shouldn't be a push without a Jira created previously

Approvals and Voting Process:

For code-modification, +1 votes are in favor of the proposal, but -1 votes are vetos and kill the proposal dead until all vetoers withdraw their -1 votes.

Unless a vote has been declared as using lazy consensus, three +1 votes are required for a code-modification proposal to pass.

Whole numbers are recommended for this type of vote, as the opinion being expressed is Boolean: 'I approve/do not approve of this change.'

Source: http://apache.org/foundation/voting.html

Bug Process Creation for Spothreat (Incubator) Project in Jira

How to guide to open bugs: the following guide is intended for any contributor working with the Spothreat (Incubator) project that needs to create a bug in Jira.

Creating a bug in ASF Jira for Spot (Incubating) project.

To create bugs for Spothreat (Incubator) in Jira use the following link: https://issues.apache.org/jira/secure/Dashboard.jspa

It is required to have an active account to create bugs. An account can be created using the Sign Up link below the login form.

Once an account has be created and logged into Jira a Create button in RED will be displayed. Click the Create Button to open a new bug:

A template window will show up, make sure to select Spot for the Project field and select the Bug value for Issue Type field.

For summary, we recommend using the following naming convection: [Component][Pipeline]: "Bug Description"

E.g.: [Ingest][Flow]: Ingest not ingesting data from defined path on Hadoop.

Priority: Please select "Triage" on the bug priority so the spothreat committee can review and analyze the bug to define the best priority based on the information of the bug.

Components: Ingest, Machine Learning, Operational Analytics, User Interface.

Affects Version: The branch you installed on your environment.

Environment: Please describe the environment you currently have where you installed spothreat. This includes, OS Version, Hadoop Version, No. of nodes., under what node you have installed, Ingest, Machine Learning, Operational Analytics/UI.

Description: Please use the following template to describe your problem:

Steps to reproduce the bug:
Actual Results:
Expected Results:

Attachments: Please upload screenshots and logs of your findings that will be useful to debug the problem.

Leave the rest of the fields as default and click the Create button.

The Spothreat (Incubator) team will review all bugs that are new and in triage state to define a priority to make a fix giving a first update in the bug adding a comment regarding the problem or in case asking for more evidence and information to determine the problem.