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

LICENSE.md and expanding CONTRIBUTING.md #82

Closed
FranciscoKnebel opened this issue Oct 13, 2017 · 4 comments
Closed

LICENSE.md and expanding CONTRIBUTING.md #82

FranciscoKnebel opened this issue Oct 13, 2017 · 4 comments

Comments

@FranciscoKnebel
Copy link
Contributor

Licensing is really important. Since everything is intended to be open, I suggest just using MIT, but if you have other ideas for it, please add it.

CONTRIBUTING.md is a bit vague in some points. It's clearly not strict on coding style patterns, perhaps by intention, but for maintainability, PR names should be strictly defined.
I suggest more specific rules for pull requests, so you can easily identify the type of PR and category, algorithm and language of the implementation.

I can suggest a structure for PRs, if you approve of this change, and then implement it on the markdown files.

@FranciscoKnebel
Copy link
Contributor Author

@nimit95 @piyush6348 What do you think? 😄

@nimit95
Copy link
Member

nimit95 commented Oct 18, 2017

yeah happy to accept changes :)

@FranciscoKnebel
Copy link
Contributor Author

OK, I thought about some points for each PR:

Pull Requests

We need to identify category, algorithm and language.

  • I suggest all new PRs need to be titled with a model, like category: algorithm (language).
    Ex1: Sorting: Bubble Sort (C)
    Ex2: Searching: Binary Search (Java)
    This model could be extended to include implementation name.

  • The PR template should contain checkboxes for the definitions from CONTRIBUTION.md, so the contributor vouches that his changes follow the guidelines, which saves time on code reviews.

  • PRs should be single commit only. You should squash all commits into one and then submit your changes, so it's easier to handle the code history.

License

  • OK to insert the MIT license or you have other plans?

@nimit95
Copy link
Member

nimit95 commented Oct 21, 2017

Yeah, all these things seem fine, can you change in readme and contribution.md and make a pull request?

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

No branches or pull requests

2 participants