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

Main README.md for this repo #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alexandrx
Copy link
Member

Created main README.md for this repo, moved the old one to the datasets/fuRo folder, added template for datasets contents and a basic example.

@alexandrx alexandrx requested a review from hara-y August 2, 2020 19:15
Copy link
Member

@hara-y hara-y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the pull request.

We want to keep the README simple and monolithic.

We'd like to consider picking out the important parts from your pull request and adding them individually.

@alexandrx
Copy link
Member Author

@hara-y Thanks for the review.

A monolithic README means anybody can modify it, or else it is the duty of this repository members to carefully go through the proposed changes, filter things and then add. In addition, people may want to contribute a dataset but don't know where to place the information in the monolithic README, and may even want to use Japanese language. Therefore, it will be a mess to deal with. I recommend against such a structure.

Instead, if we allow them to have their own folder where they keep their dataset and their changes, everything is more simple to control and maintain. I included a template of the README.md file and an example, so people can easily fill in the details.

In the front README.md, we will keep news and an index to the datasets contributed to this repo so it is easier to navigate, also the rules for contributing which I already wrote.

That's what I'm proposing here.

@hara-y
Copy link
Member

hara-y commented Aug 3, 2020

@alexandrx

I understand what you're saying. However, at this early stage, I think we will only get a few pull requests.

For users who are not good at English, we want to be able to access the dataset files with fewer clicks. We also want to organize the datasets by course (the year of the Tsukuba Challenge) rather than by team.

For these reasons, we prefer a monolithic README for this first step.

If we get a lot of pull requests and there is confusion, as you say, we would want to separate the datasets into directories.

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

Successfully merging this pull request may close these issues.

2 participants