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

Version 1.0.0 proposal #2

Merged
merged 16 commits into from
Feb 5, 2016
Merged

Version 1.0.0 proposal #2

merged 16 commits into from
Feb 5, 2016

Conversation

wrygiel
Copy link
Contributor

@wrygiel wrygiel commented Jan 26, 2016

No description provided.

- We want a single issue tracker for all the projects.
- Added a section for preferred data and documentation formats.
- Made documentation clearer in multiple places.
* Merge all the docs into a single file.
* Move some parts to other documents.
* Large number of changes to existing parts.
Fixes issue #1.
We might still use JSON in some API, so it wouldn't be appropriate to
release a document stating that we will use XML Schema only.

The list partner developers is not complete it would be better to remove
it for now. Maybe it will be brought back later.
GitHub. **We will require developers to review and accept documentation
often** throughout the project. We believe that these tools will help them
with this task.

Copy link

Choose a reason for hiding this comment

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

I'd say "All developers are familiar with Git" is a bit too far fetched, there are other version control systems, and some people have been using them before Git existed and may even find the transition uncomfortable or not have the time to learn new "tricks"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, I'll try to rephrase that in the new version.

Side note: Do you think that it would be difficult for non-Git developers to import our history to their own favorite version control system? Or, if not entire history, then at least the versions they are about to review?

Copy link

Choose a reason for hiding this comment

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

Actually, what I meant is that it was a bit to much to expect that. But,
I agree that some decisions have to be taken when you launch a project,
so it should be up to the developer to decide if they prefer to learn
Git or to find a way to interface her favourite tool with Git.

wrygiel added a commit that referenced this pull request Feb 5, 2016
@wrygiel wrygiel merged commit 1906776 into stable-v1 Feb 5, 2016
@wrygiel wrygiel deleted the stable-v1-review branch February 5, 2016 13:13
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