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

Contribution instructions #1805

Closed
jussimalinen opened this issue Sep 22, 2014 · 9 comments
Closed

Contribution instructions #1805

jussimalinen opened this issue Sep 22, 2014 · 9 comments

Comments

@jussimalinen
Copy link
Member

We should have CONTRIBUTING.md or similar instructing on how to contribute to the project.

@jussimalinen
Copy link
Member Author

We should explain there how the pull request builder works on CI.

When a new pull request comes in, the CI will ask if one of the admins can verify the pull request. The admins are currently me and Pekka. The commands are:
robotci: once (run once)
robotci: enable (run when ever this pull request changes)
robotci: whitelist user (enable CI for all pullrequests coming from this user)

The commands can be anywhere on the comment. Adding the skip statement ([skip ci], with the square brackets) to the pull request body will cause the job not to run.

@jussimalinen
Copy link
Member Author

More about the ci on #1768

@guykisel
Copy link
Contributor

guykisel commented Dec 8, 2014

At some point it was mentioned that there should be a contributor license agreement. Maybe you already knew about this, but I just learned that Github has a service for doing this: https://www.clahub.com/

@pekkaklarck
Copy link
Member

We are creating alpha 2 today. After that getting contribution guidelines released is my highest priority.

@jussimalinen
Copy link
Member Author

...and now moving to rc1..

@pekkaklarck
Copy link
Member

I've merged PR #1805 by @guykisel and enhanced the initial guidelines considerably afterwards. Review by @jussimalinen, @guykisel and everyone else would be great. As a non-native English writer comments about used language are highly appreciated. Comments can be added to the individual commits or left here, and with larger changes PRs are probably the best approach.

I plan to proofread this myself once more before making RF 2.9 rc 1 tomorrow. Documentation changes are possible also after it.

@guykisel
Copy link
Contributor

Looks pretty good! The enhancements are very helpful. Left a few comments on one of the commits with minor typo fixes.

@pekkaklarck
Copy link
Member

Thanks a lot for the review @guykisel! Fixed the issues you found and also enhanced guidelines a little afterwards. I think this issue can be considered done. That obviously doesn't mean we couldn't enhance the guidelines in the future.

@laurentbristiel
Copy link
Contributor

Thank for the work guys!
I did a quick review of the doc and found 2 typos.
Created #2066 to fix them.

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

No branches or pull requests

4 participants