atom-community / atom-ide-definitions

Definitions for Atom IDE
https://atom.io/packages/atom-ide-definitions
Other
24 stars 4 forks source link

docs: rename Development.md to CONTRIBUTING.md #3

Closed vinkla closed 5 years ago

vinkla commented 5 years ago

This way we can take advantage of the contributing guidelines feature.

https://github.blog/2012-09-17-contributing-guidelines/

Since many of these package will behave in similarly we could use the new organization-wide community health files feature. What do you think?

ryanolsonx commented 5 years ago

Ah, good catch! 👍

Can you also update the link in the README?

vinkla commented 5 years ago

Should we maybe close this PR and use organization-wide community health files instead?

ryanolsonx commented 5 years ago

Oh sorry, I only checked your first link. I don't think we should use organization-wide community health files.

The primary reason behind that is we're hoping that we can get some third-party package developers to move their packages into our organization. These existing packages might already have their own their own development practices that they would want to continue to follow (which is totally fine).

It would be great if the transition was seamless. We don't want to constrain other developers to follow the approaches that @appelgriebsch and I have decided to use on some of these packages.

So - I think we should rename Development.md to CONTRIBUTING.md and call it good for now.

vinkla commented 5 years ago

I've gone ahead and updated the README.

ryanolsonx commented 5 years ago

Will merge once CI has finished successfully.

ryanolsonx commented 5 years ago

:tada: This PR is included in version 0.2.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: