Skip to content

Commit 8c7f3ba

Browse files
author
Adam Richie-Halford
committed
Add contribution guidelines and set up sentimentBot and welcomeBot
1 parent 216364a commit 8c7f3ba

File tree

3 files changed

+137
-1
lines changed

3 files changed

+137
-1
lines changed

.github/config.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Configuration for sentiment-bot - https://github.com/behaviorbot/sentiment-bot
2+
3+
# *Required* toxicity threshold between 0 and .99 with the higher numbers being the most toxic
4+
# Anything higher than this threshold will be marked as toxic and commented on
5+
sentimentBotToxicityThreshold: .7
6+
7+
# *Required* Comment to reply with
8+
sentimentBotReplyComment: >
9+
SentimentBot thinks that this comment is toxic. Perhaps SentimentBot got it wrong. But then again, maybe you did.
10+
11+
Please reread your comment and take advantage of any opportunities to "turn down the temperature." We want the Cloudknot community to be inclusive and welcoming. Please be respectful of other users and think about ways to communicate the same message in a more delicate manner. cc/ @richford
12+
13+
#=======================================================================
14+
15+
# Configuration for welcome - https://github.com/behaviorbot/welcome
16+
17+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
18+
19+
# Comment to be posted to on first time issues
20+
newIssueWelcomeComment: >
21+
👋 Thanks for opening your first issue here! We appreciate your help making Cloudknot better.
22+
23+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
24+
25+
# Comment to be posted to on PRs from first time contributors in your repository
26+
newPRWelcomeComment: >
27+
Thanks for opening this pull request! Please check out our contributing guidelines.
28+
29+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
30+
31+
# Comment to be posted to on pull requests merged by a first time user
32+
firstPRMergeComment: >
33+
Congrats on merging your first pull request! We're proud of you! 🎉🎉🎉
34+
35+
# It is recommended to include as many gifs and emojis as possible!
36+
37+
#=======================================================================

CONTRIBUTING.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit
4+
helps, and credit will always be given.
5+
6+
You can contribute in many ways:
7+
8+
## Types of Contributions
9+
10+
### Report Bugs
11+
12+
Report bugs at https://github.com/richford/cloudknot/issues.
13+
14+
If you are reporting a bug, please include:
15+
16+
- Your operating system name and version.
17+
- Any details about your local setup that might be helpful in troubleshooting.
18+
- Detailed steps to reproduce the bug.
19+
20+
### Work on "good first issues"
21+
22+
Look through the GitHub issues for anything labelled "good first issue." These
23+
are issues that we think would be especially appropriate for those new to
24+
open-source software contribution.
25+
26+
### Fix Bugs
27+
28+
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
29+
wanted" is open to whoever wants to implement it.
30+
31+
### Implement Features
32+
33+
Look through the GitHub issues for features. Anything tagged with "enhancement"
34+
and "help wanted" is open to whoever wants to implement it.
35+
36+
### Write Documentation
37+
38+
Cloudknot could always use more documentation, whether as part of the
39+
official afq-insight docs, in docstrings, or even on the web in blog posts,
40+
articles, and such.
41+
42+
### Submit Feedback
43+
44+
The best way to send feedback is to file an issue at
45+
https://github.com/richford/cloudknot/issues.
46+
47+
If you are proposing a feature:
48+
49+
- Explain in detail how it would work.
50+
- Keep the scope as narrow as possible, to make it easier to implement.
51+
- Remember that this is a volunteer-driven project, and that contributions
52+
are welcome :)
53+

README.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
## cloudknot
1+
# cloudknot
2+
23
[![Build Status](https://travis-ci.org/richford/cloudknot.svg?branch=master)](https://travis-ci.org/richford/cloudknot)
34
[![DOI](https://zenodo.org/badge/102051437.svg)](https://zenodo.org/badge/latestdoi/102051437)
45

@@ -10,3 +11,48 @@ This is the cloudknot development site. You can view the source code, file new
1011
issues, and contribute to cloudknot's development. If you are just getting
1112
started, you should look at the
1213
[cloudknot documentation](https://richford.github.io/cloudknot/).
14+
15+
16+
## Contributing
17+
18+
We love contributions! Cloudknot is open source, built on open source,
19+
and we'd love to have you hang out in our community.
20+
21+
We have developed some [guidelines](CONTRIBUTING.md) for contributing to
22+
AFQ-Insight.
23+
24+
**Imposter syndrome disclaimer**: We want your help. No, really.
25+
26+
There may be a little voice inside your head that is telling you that
27+
you're not ready to be an open source contributor; that your skills
28+
aren't nearly good enough to contribute. What could you possibly offer a
29+
project like this one?
30+
31+
We assure you - the little voice in your head is wrong. If you can
32+
write code at all, you can contribute code to open source. Contributing
33+
to open source projects is a fantastic way to advance one's coding
34+
skills. Writing perfect code isn't the measure of a good developer (that
35+
would disqualify all of us!); it's trying to create something, making
36+
mistakes, and learning from those mistakes. That's how we all improve,
37+
and we are happy to help others learn.
38+
39+
Being an open source contributor doesn't just mean writing code, either.
40+
You can help out by writing documentation, tests, or even giving
41+
feedback about the project (and yes - that includes giving feedback
42+
about the contribution process). Some of these contributions may be the
43+
most valuable to the project as a whole, because you're coming to the
44+
project with fresh eyes, so you can see the errors and assumptions that
45+
seasoned contributors have glossed over.
46+
47+
48+
## Credits
49+
50+
This package was created with
51+
[shablona](https://github.com/uwescience/shablona).
52+
53+
The imposter syndrome disclaimer was originally written by
54+
[Adrienne Lowe](https://github.com/adriennefriend) for a [PyCon
55+
talk](https://www.youtube.com/watch?v=6Uj746j9Heo), and was
56+
adapted based on its use in the README file for the [MetPy
57+
project](https://github.com/Unidata/MetPy).
58+

0 commit comments

Comments
 (0)