forked from snowplow/snowplow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Common: update CONTRIBUTING.md (closes snowplow#3530)
- Loading branch information
Showing
1 changed file
with
95 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,109 @@ | ||
| # Contributing to Snowplow | ||
| # Contributor guide | ||
|
|
||
| So you want to contribute to Snowplow? Fantastic! Here's a brief overview on | ||
| how best to do so. | ||
| Snowplow is maintained by the pipeline team at Snowplow Analytics and improved on by external contributors for which we are | ||
| extremely grateful. | ||
|
|
||
| ## Support request? | ||
| ## Getting in touch | ||
|
|
||
| If you are having trouble setting up or running Snowplow, then the best place to get help is on the [Snowplow Discourse](https://discourse.snowplowanalytics.com/). | ||
| ### Community support requests | ||
|
|
||
| Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on GitHub. Please do create a new issue on GitHub if you think you've found a bug though! | ||
| First and foremost, please do not log an issue if you are asking for support, all of our community support requests go through | ||
| our Discourse forum: https://discourse.snowplowanalytics.com/. | ||
|
|
||
| ## What to change | ||
| Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on | ||
| GitHub. Please do create a new issue on GitHub if you think you've found a bug though! | ||
|
|
||
| Here's some examples of things you might want to make a pull request for: | ||
| ### Gitter | ||
|
|
||
| * New features | ||
| * Bugfixes | ||
| * Inefficient blocks of code | ||
| If you want to discuss already created issues, potential bugs, new features you would like to work on or any kind of developer | ||
| chat, you can head over to our [Gitter room](https://gitter.im/snowplow/snowplow). | ||
|
|
||
| If you have a more deeply-rooted problem with how the program is built or some | ||
| of the stylistic decisions made in the code, it's best to | ||
| [create an issue](https://github.com/snowplow/snowplow/issues/new) before putting | ||
| the effort into a pull request. The same goes for new features - it might be | ||
| best to check the project's direction, existing pull requests, and currently open | ||
| and closed issues first. | ||
| ## Roadmap visibility | ||
|
|
||
| ## Style | ||
| Being an open source company, transparency is very important to us, that's why we try to share as much as possible regarding | ||
| what we will be working on next so that you can: | ||
|
|
||
| * Two spaces, not tabs | ||
| * Trailing newline at end of source files | ||
| * No editor-specific cruft in source code or `.gitignore` | ||
| * Code should follow our accepted style guides (coming soon) | ||
| - see how your contributions fit into our roadmap | ||
| - help us design new features | ||
| - share your opinions on the technical direction of the Snowplow pipeline | ||
|
|
||
| Look at existing code to get a good feel for the patterns we use. | ||
| You can peek into what the pipeline team is working on by looking at | ||
| [the open GitHub projects](https://github.com/snowplow/snowplow/projects). | ||
|
|
||
| ## Using Git appropriately | ||
| For insights into what we will be working on next, you can look at | ||
| [the RFC category in our Discourse](https://discourse.snowplowanalytics.com/c/roadmap/rfcs). | ||
|
|
||
| 1. [Fork the repository](https://github.com/snowplow/snowplow/fork_select) to | ||
| your GitHub account | ||
| 2. Create a *topical branch* - a branch whose name is succint but explains what | ||
| you're doing, such as "feature/storm-etl" | ||
| 3. Make your changes, committing at logical breaks | ||
| 4. Push your branch to your personal account | ||
| 5. [Create a pull request](https://help.github.com/articles/using-pull-requests) | ||
| 6. Watch for comments or acceptance | ||
| ## Repository structure | ||
|
|
||
| Please note - if you want to change multiple things that don't depend on each | ||
| other, make sure you check the master branch back out before making more | ||
| changes - that way we can take in each change seperately. | ||
| The `snowplow/snowplow` project is split into different Scala projects: | ||
|
|
||
| - [`2-collectors/scala-stream-collector`](https://github.com/snowplow/snowplow/tree/master/2-collectors/scala-stream-collector) | ||
| which contains the code to collect events as HTTP requests and output raw events to a streaming platform (Kafka, Kinesis, | ||
| NSQ or PubSub) | ||
| - [`3-enrich/scala-common-enrich`](https://github.com/snowplow/snowplow/tree/master/3-enrich/scala-common-enrich), a | ||
| library common to all the enrichers listed below which turns the raw events outputted by a collector into validated and | ||
| enriched events | ||
| - [`3-enrich/spark-enrich`](https://github.com/snowplow/snowplow/tree/master/3-enrich/spark-enrich), the pipeline which | ||
| turns batch of raw events into batch of validated and enriched events thanks to [Apache Spark](https://spark.apache.org/) | ||
| and Scala Common Enrich | ||
| - [`3-enrich/stream-enrich`](https://github.com/snowplow/snowplow/tree/master/3-enrich/stream-enrich), the pipeline which | ||
| turns a stream of raw events into a stream of validated and enriched events and pushes them to a streaming platform (Kafka, | ||
| Kinesis, NSQ or PubSub) | ||
| - [`3-enrich/beam-enrich`](https://github.com/snowplow/snowplow/tree/master/3-enrich/stream-enrich), the successor of | ||
| Stream Enrich built on [Apache Beam](https://beam.apache.org/). | ||
|
|
||
| All of these projects can be built and tested with [SBT](https://www.scala-sbt.org/). | ||
|
|
||
| ## Issues | ||
|
|
||
| ### Creating an issue | ||
|
|
||
| The project contains an issue template which should help guiding you through the process. However, please keep in mind | ||
| that support requests should go to our Discourse forum: https://discourse.snowplowanalytics.com/ and not GitHub issues. | ||
|
|
||
| It's also a good idea to log an issue before starting to work on a pull request to discuss it with the maintainers. | ||
|
|
||
| ### Working on an issue | ||
|
|
||
| If you see an issue you would like to work on, please let us know in the issue! That will help us in terms of scheduling and | ||
| not doubling the amount of work. | ||
|
|
||
| If you don't know where to start contributing, you can look at | ||
| [the issues labeled `good first issue`](https://github.com/snowplow/snowplow/labels/good%20first%20issue). | ||
|
|
||
| ## Pull requests | ||
|
|
||
| These are a few guidelines to keep in mind when opening pull requests, there is a GitHub template that reiterates most of the | ||
| points described here. | ||
|
|
||
| ### Commit hygiene | ||
|
|
||
| We keep a strict 1-to-1 correspondance between commits and issues, as such our commit messages are formatted in the following | ||
| fashion: | ||
|
|
||
| `Component: add issues description (closes #1234)` | ||
|
|
||
| for example: | ||
|
|
||
| `Scala Common Enrich: add Vero adapter (closes #1234)` | ||
|
|
||
| ### Writing tests | ||
|
|
||
| Whenever necessary, it's good practice to add the corresponding unit tests to whichever feature you are working on. | ||
|
|
||
| ### Feedback cycle | ||
|
|
||
| Reviews should happen fairly quickly during weekdays. If you feel your pull request has been forgotten, please ping one | ||
| or more maintainers in the pull request. | ||
|
|
||
| ### Getting your pull request merged | ||
|
|
||
| If your pull request is fairly chunky, there might be a non-trivial delay between the moment the pull request is approved and | ||
| the moment it gets merged. This is because your pull request will have been scheduled for a specific milestone which might or | ||
| might not be actively worked on by a maintainer at the moment. | ||
|
|
||
| ### Contributor license agreement | ||
|
|
||
| We require outside contributors to sign a Contributor license agreement (or CLA) before we can merge their pull requests. | ||
| You can find more information on the topic in [the dedicated wiki page](https://github.com/snowplow/snowplow/wiki/CLA). | ||
| The @snowplowcla bot will guide you through the process. |