Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document with the events spec #108

Merged
merged 4 commits into from Mar 18, 2019

Conversation

Projects
None yet
2 participants
@rafeca
Copy link
Contributor

commented Mar 18, 2019

This PR adds a document which specifies all the data that gets logged by Atom core.


Rendered version

@rafeca rafeca requested a review from annthurium Mar 18, 2019

rafeca added some commits Mar 18, 2019

Update template for PRs
Add a comment about updating the docs
@@ -2,6 +2,7 @@

* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* All new code requires tests to ensure against regressions
* If you add/remove/modify any event please update the [documentation](docs/events.md)

This comment has been minimized.

Copy link
@annthurium

annthurium Mar 18, 2019

Contributor

I worry this seems prone to the human error of forgetting.

I can't think of an easy way to automatically or programmatically keep this updated though :-(

This comment has been minimized.

Copy link
@rafeca

rafeca Mar 18, 2019

Author Contributor

Yup I agree... Unless we move to a fixed schema for the events and use it to generate the docs I can't see an easy way to ensure that this doc is up to date... And this seems like too much work


These events are used to count how many times a certain action happens. They don't hold any metadata and they only log the name of the counter and the number of times it was incremented.

Currently Atom core is not logging any counter event, but the [GitHub package](https://github.com/atom/github) is using counters to log things like the number of created PRs.

This comment has been minimized.

Copy link
@annthurium

annthurium Mar 18, 2019

Contributor

did you want the events logged by atom/github to be listed in detail here?

This comment has been minimized.

Copy link
@rafeca

rafeca Mar 18, 2019

Author Contributor

Good question 😄 I'm not sure about it...

it would be good to have all the events in a single place but as you mention in the other comment it's going to be hard to keep the docs updated, so if we have also events from other repos it's going to be even harder 😟

What do you think?

@rafeca rafeca merged commit 4a931c3 into master Mar 18, 2019

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@rafeca rafeca deleted the add-events-doc branch Mar 18, 2019

@rafeca rafeca self-assigned this Mar 19, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.