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

Separate out notes into checks and action items #59

Open
3 of 8 tasks
RichardLitt opened this issue Nov 20, 2017 · 0 comments
Open
3 of 8 tasks

Separate out notes into checks and action items #59

RichardLitt opened this issue Nov 20, 2017 · 0 comments

Comments

@RichardLitt
Copy link
Member

The notes we currently have are not ideal. See shutterstock/juxtaposer#19:


Dearest humans,

You are missing some important community files. I am adding them here for you!

Here are some things you should do manually before merging this Pull Request:

  • Update the Contributing guide to include any repository-specific requests, or to point to a global Contributing document.
  • Check the email in the Code of Conduct. We've added in "open-source@shutterstock.com".
  • Check that nothing drastic happened in the package.json.
  • Add some keywords to your package.json. We've added an empty keywords field for now.
  • Check that the homepage in the package.json is OK. Another one besides your GitHub repo might work. We've set it to https://github.com/shutterstock/juxtaposer.
  • If there are more contributors, add them to the Contributors field in the package.json.
  • Add some tests! There aren't any currently set.
  • Consider adding Travis. Travis is useful not only for tests, but also for greenkeeper and semantic-release.

Note: This pull request was automatically generated by https://github.com/mntnr/build-a-space. Found an issue? Let me know!


"Update the guide" requires a check, but not necessarily any manual work. The same could be said of the CoC. However, "Add some keywords" requires manual work. Why don't you split these two types of notes up to make it easier to see what to do and what not to do.

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

No branches or pull requests

1 participant