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.

Sign up for GitHub

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

Jump to bottom

Update Readme for New Features #1368

Closed
ritwik12 opened this issue Sep 27, 2019 · 4 comments
Closed

Update Readme for New Features #1368

ritwik12 opened this issue Sep 27, 2019 · 4 comments
Labels
discussion open-ended issues that haven't yet defined what needs to be worked on

Comments

@ritwik12
Copy link
Collaborator

Since, everyday we are making up-for-grabs.net better and better with new features. It will be good to keep everyone in the same loop so that they will be aware of what all up-for-grabs provides and uses to contribute better.

A good start will be to see the latest merged PRs with new features and Issues solved.
This was referenced Oct 1, 2019
Open
Merged
@shiftkey
Copy link
Member

shiftkey commented Oct 5, 2019

A good start will be to see the latest merged PRs with new features and Issues solved.

I don't agree these are the best things to put into the README, because they're likely to go stale quick. What I'd like to see in the README for this project is the details that cover:

  • an introduction to what the project is about
  • if you're a project maintainer, what's important to know?
  • if you're interested in contribution, what's important to know?
  • if you're looking for more documentation about the project, where is it?

There's some detailed instructions currently in the README that isn't very out of date which I think can be moved out to separate documentation:

  • how to setup your environment and test the site
  • how to scaffold the project
  • how the site gets published
  • what automation is running and what does it do?

I think that would lead to a much easier to follow README. If we're 👍 on this direction I can open some issues to track the specific tasks I had in mind, so others can help out.

@shiftkey shiftkey added discussion open-ended issues that haven't yet defined what needs to be worked on and removed up-for-grabs labels Oct 5, 2019
@ritwik12
Copy link
Collaborator Author

ritwik12 commented Oct 5, 2019

@shiftkey I think I made it confusing, By A good start will be to see the latest merged PRs with new features and Issues solved. I meant the code changes that we do to make up-for-grabs better like the latest stats feature. I never meant adding details about projects being added to up-for-grabs. That's irrelevant.

I agree with you let's open issues.

This was referenced Oct 5, 2019
Closed
Closed
Closed
Closed
Merged
This was referenced Oct 14, 2019
Closed
Merged
@shiftkey
Copy link
Member

shiftkey commented Nov 4, 2019

@ritwik12 with #1614 merged I'm feeling pretty good about how the current README summarises and introduces the project. If we have more specific ideas for the README, I think these should be separate and more-specific discussions, like #1393.

Are we good to close this out?

@ritwik12
Copy link
Collaborator Author

ritwik12 commented Nov 5, 2019

@shiftkey Lgtm!!

@ritwik12 ritwik12 closed this as completed Nov 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discussion open-ended issues that haven't yet defined what needs to be worked on
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@shiftkey @ritwik12