API Freeze : Atom 1.0-pre #3041

Closed
benogle opened this Issue Jul 22, 2014 · 7 comments

Comments

Projects
None yet
7 participants
@benogle
Contributor

benogle commented Jul 22, 2014

The goal is to improve the package writing experience and settle on an API we will support through 1.0. This means cleaning up the API, writing better API documentation and redesigning the API webpage.

The result of the API freeze will be an solid structure on which we can build. A lot of methods and approaches will be deprecated, but nothing will be removed until we near 1.0. We will be able to add more APIs after the freeze, but will commit to not removing anything until the next major.

Tasks

Punting on for now

  • Convert the internal views to HTML custom elements #3677 #3679
  • Come up with api for creating views in packages #3752
  • Use custom tags in tree-view and status-bar.

Open Issues

See https://github.com/atom/atom/labels/api-freeze-roadmap for a list of open issues

@benogle benogle added the milestone label Jul 22, 2014

@kevinsawicki

This comment has been minimized.

Show comment
Hide comment
@kevinsawicki

kevinsawicki Jul 23, 2014

Member

What do you think about removing Experiment with rewriting packages in React?

I don't see the value in this one and it is really vague, we can always do this in the future, nothing about the 1.0 API would be dependent on it, since packages don't really expose APIs.

Was this referring to any packages specifically? If it is, it might be clearer to just list those.

Member

kevinsawicki commented Jul 23, 2014

What do you think about removing Experiment with rewriting packages in React?

I don't see the value in this one and it is really vague, we can always do this in the future, nothing about the 1.0 API would be dependent on it, since packages don't really expose APIs.

Was this referring to any packages specifically? If it is, it might be clearer to just list those.

@probablycorey

This comment has been minimized.

Show comment
Hide comment
@probablycorey

probablycorey Jul 23, 2014

Member

@kevinsawicki, that sounds good to me. I'll going to edit the issue body.

Member

probablycorey commented Jul 23, 2014

@kevinsawicki, that sounds good to me. I'll going to edit the issue body.

@probablycorey probablycorey changed the title from API rework + stability: 1.0-pre to 1.0.0-pre Jul 23, 2014

@benogle

This comment has been minimized.

Show comment
Hide comment
@benogle

benogle Jul 23, 2014

Contributor

Experiment with rewriting packages in React

I think this is valuable because we are going to be persuading people to use react to write their packages. They're going to look at the builtin packages, and think, "this doesnt use react. I know jquery, I'm using that." Or, "I'm copying this bit cause it mostly does what I want."

Also, we should rewrite a couple of the packages just so we know where the sharp edges are and nice patterns to use when writing with react.

Contributor

benogle commented Jul 23, 2014

Experiment with rewriting packages in React

I think this is valuable because we are going to be persuading people to use react to write their packages. They're going to look at the builtin packages, and think, "this doesnt use react. I know jquery, I'm using that." Or, "I'm copying this bit cause it mostly does what I want."

Also, we should rewrite a couple of the packages just so we know where the sharp edges are and nice patterns to use when writing with react.

@batjko

This comment has been minimized.

Show comment
Hide comment
@batjko

batjko Jul 23, 2014

Contributor

As an unseasoned developer, I would suggest to document those re-writes, maybe in blog posts if they are interesting enough, which would help everyone getting to know the differences and advantages of using React or even to use Atom as a first test bed to start learning about it.

Contributor

batjko commented Jul 23, 2014

As an unseasoned developer, I would suggest to document those re-writes, maybe in blog posts if they are interesting enough, which would help everyone getting to know the differences and advantages of using React or even to use Atom as a first test bed to start learning about it.

@ilanbiala

This comment has been minimized.

Show comment
Hide comment
@ilanbiala

ilanbiala Aug 5, 2014

+1 for documentation of rewriting core Atom packages, that would be really helpful.

+1 for documentation of rewriting core Atom packages, that would be really helpful.

@benogle benogle added product-roadmap and removed milestone labels Sep 30, 2014

@benogle benogle changed the title from 1.0.0-pre to API Freeze : 1.0.0-pre Sep 30, 2014

@benogle benogle added the in-progress label Sep 30, 2014

@benogle

This comment has been minimized.

Show comment
Hide comment
@benogle

benogle Sep 30, 2014

Contributor

Updated to reflect the current state of things. This will be our tracking issue through the remaining duration of the API freeze initiative.

Contributor

benogle commented Sep 30, 2014

Updated to reflect the current state of things. This will be our tracking issue through the remaining duration of the API freeze initiative.

@benogle benogle changed the title from API Freeze : 1.0.0-pre to API Freeze : Atom 1.0-pre Sep 30, 2014

@nathansobo nathansobo added shipping and removed in-progress labels Jan 7, 2015

@benogle

This comment has been minimized.

Show comment
Hide comment
@benogle

benogle Jan 16, 2015

Contributor

Donezo

Contributor

benogle commented Jan 16, 2015

Donezo

@benogle benogle closed this Jan 16, 2015

@50Wliu 50Wliu removed the in-progress label Apr 22, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment