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

API Freeze : Atom 1.0-pre #3041

Closed
18 of 21 tasks
benogle opened this issue Jul 22, 2014 · 8 comments
Closed
18 of 21 tasks

API Freeze : Atom 1.0-pre #3041

benogle opened this issue Jul 22, 2014 · 8 comments

Comments

@benogle
Copy link
Contributor

@benogle 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

@kevinsawicki
Copy link
Member

@kevinsawicki 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
Copy link

@probablycorey probablycorey commented Jul 23, 2014

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

@probablycorey probablycorey changed the title API rework + stability: 1.0-pre 1.0.0-pre Jul 23, 2014
@benogle
Copy link
Contributor Author

@benogle 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
Copy link
Contributor

@batjko 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
Copy link

@ilanbiala ilanbiala commented Aug 5, 2014

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

@benogle benogle changed the title 1.0.0-pre API Freeze : 1.0.0-pre Sep 30, 2014
@benogle
Copy link
Contributor Author

@benogle 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 API Freeze : 1.0.0-pre API Freeze : Atom 1.0-pre Sep 30, 2014
@benogle
Copy link
Contributor Author

@benogle benogle commented Jan 16, 2015

Donezo

@lock
Copy link

@lock lock bot commented Jan 22, 2019

This issue has been automatically locked since there has not been any recent activity after it was closed. If you can still reproduce this issue in Safe Mode then please open a new issue and fill out the entire issue template to ensure that we have enough information to address your issue. Thanks!

@lock lock bot locked as resolved and limited conversation to collaborators Jan 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants