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

Add guidelines for contributing #75

Closed
szszszsz opened this issue May 25, 2016 · 4 comments
Closed

Add guidelines for contributing #75

szszszsz opened this issue May 25, 2016 · 4 comments
Assignees
Milestone

Comments

@szszszsz
Copy link
Member

szszszsz commented May 25, 2016

Add CONTRIBUTING.md with:

  • code style guidelines (code reformatting)
  • git flow description
  • make as small consisting changes as possible within one PR (eg. do not mix translations and functional changes)
  • do not mix functional changes with not own code reformat
  • what issue description should contain (OS, stick firmware, app version)
@FlorianUekermann
Copy link

-Compile without warnings (on at least one recent compiler version).
-Pass llvm-format without changes (use a style config file if necessary)
-Don't break ability to compile (at least on amd64)
Use travis to enforce these and to always have binary builds.

@jans23 jans23 added this to the 0.5 milestone Aug 9, 2016
@szszszsz szszszsz self-assigned this Aug 13, 2016
szszszsz added a commit that referenced this issue Aug 13, 2016
Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
@szszszsz
Copy link
Member Author

@jans23 @MaVo159
Please check guidelines submitted in commit. Further additions should be made in issue_75-contributing. Please update in case of obvious errors in separate commits.

szszszsz added a commit that referenced this issue Aug 13, 2016
Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
szszszsz added a commit that referenced this issue Aug 13, 2016
Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
@FlorianUekermann
Copy link

The .md contents sound pretty good. I didn't look at more stuff. I'm a little confused why there are 3 commits that add the same file (is it the same?). I'm on mobile, so it is difficult to check what is going on. Anyway, looks good to me.

@szszszsz
Copy link
Member Author

Great! You can visualize it under link
These are all same commit (technically different) on same branch - I have updated the content two times because of typos.

szszszsz added a commit that referenced this issue Aug 24, 2016
Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
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

3 participants