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

CONTRIBUTING.md: migrate parts of wiki and add general tips #12786

Merged
merged 5 commits into from
Jan 16, 2020

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Nov 22, 2019

Contribution description

This moves some of the contributing guidelines from various wiki pages to CONTRIBUTING.md in an effort to centralize documentation.

It also adds a list of tips, that we discussed offline today.

Testing procedure

Read!

Issues/PRs references

Addresses #12779.

@miri64 miri64 added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation labels Nov 22, 2019
@MrKevinWeiss
Copy link
Contributor

I looked over this and recommended what I could, maybe @kaspar030, @haukepetersen and @smlng could give some input.

@MrKevinWeiss
Copy link
Contributor

and @OlegHahm

the mailing list or open an issue saying which documentation is missing. The
other RIOTers will help you find the right format.

### Issues
Copy link
Member Author

Choose a reason for hiding this comment

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

Please note that I think that this subsection ("Issues") and the subsection that follows ("Contribute code") somewhat duplicate what is already described in "Feature Requests", "Bug Reports", and "Pull Requests", just in a more concise form

@miri64
Copy link
Member Author

miri64 commented Nov 26, 2019

Maybe also @aabadie? He wrote most of the original text in CONTRIBUTING.md

@miri64
Copy link
Member Author

miri64 commented Dec 6, 2019

Ping?

1 similar comment
@miri64
Copy link
Member Author

miri64 commented Jan 9, 2020

Ping?

Copy link
Contributor

@MrKevinWeiss MrKevinWeiss left a comment

Choose a reason for hiding this comment

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

I think it is an improvement, maybe this will get the ball rolling. 1 ACK.

@fjmolinas
Copy link
Contributor

ACK! Please squash.

@miri64 miri64 force-pushed the contributing/enh/wiki+tips branch from 522eac6 to 7aae27d Compare January 9, 2020 13:57
@miri64
Copy link
Member Author

miri64 commented Jan 9, 2020

ACK! Please squash.

Done

@miri64
Copy link
Member Author

miri64 commented Jan 16, 2020

Oops, this slipped through, I guess.

@miri64 miri64 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jan 16, 2020
@miri64 miri64 merged commit 22db0d9 into RIOT-OS:master Jan 16, 2020
@miri64 miri64 deleted the contributing/enh/wiki+tips branch January 16, 2020 14:40
@leandrolanzieri leandrolanzieri added this to the Release 2020.04 milestone Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants