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.

Sign up for GitHub

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

Jump to bottom

Minor typography improvement #15

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Minor typography improvement #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions 1.2-write-a-readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
#1.2 Assignment: Write a README file to Welcome All Members
The README file (whose name by convention is written in all-caps, and represents a request to one and all--- “read me!”) is one of the first things that potential members will encounter when learning about your Group. This file will live on the web, as part of a collection of working documents on your Group, called a “repository” (you'll set this up in Section 3).
The `README` file (whose name by convention is written in all-caps, and represents a request to one and all--- “read me!”) is one of the first things that potential members will encounter when learning about your Group. This file will live on the web, as part of a collection of working documents on your Group, called a “repository” (you'll set this up in Section 3).

**The aim of the README is to welcome, orient, and encourage newcomers to participate.** You’ll likely start out with a few members you know well, people from your lab or department. It’s fine to start in familiar territory-- most groups do. But your Study Group should welcome anyone who’s interested and shares your goals of learning to code together, and improving research through open practice.
**The aim of the `README` is to welcome, orient, and encourage newcomers to participate.** You’ll likely start out with a few members you know well, people from your lab or department. It’s fine to start in familiar territory-- most groups do. But your Study Group should welcome anyone who’s interested and shares your goals of learning to code together, and improving research through open practice.

If you make your group welcoming to researchers in other departments, labs, and disciplines, you’ll likely find that researchers of all stripes want to learn the same or similar tools, and share the same kinds of research problems around data analysis and visualization, data management, collaborative workflows, and much more. **Don’t feel limited by your field or area of expertise-- this is a great opportunity to make interdisciplinary connections!** As you write your Group's README, keep a diverse audience in mind.
If you make your group welcoming to researchers in other departments, labs, and disciplines, you’ll likely find that researchers of all stripes want to learn the same or similar tools, and share the same kinds of research problems around data analysis and visualization, data management, collaborative workflows, and much more. **Don’t feel limited by your field or area of expertise-- this is a great opportunity to make interdisciplinary connections!** As you write your Group's `README`, keep a diverse audience in mind.

##Write your README
IN your README, Be sure to:
In your `README`, Be sure to:

* **Say hello!** Welcome people to the Group. It’s great to introduce yourself here, so people know they’re dealing with a person or group of real people. Let potential members know you’re excited that they’re here to learn more.
* **Write a SHORT group description.** In your own words, to phrase this so it’s understandable and appealing to a wide variety of people, not just those in your field. Maybe add sentence or two about your focus for the semester or year, etc,
* **Include some key details.** Note any regular meeting times and places, contact people, etc.
* **Ask for what you need!** If your group wants to learn or work on a certain topic, but doesn't have the expertise, mention that here-- that way, perspective members can see if their skills are needed!
* **Test your Readme for Jargon** When you’re working in any field, whether it’s software engineering or astrophysics, you’ll learn and use jargon -- terms that have a special meaning to your field but likely won’t make sense to anyone who isn’t part of that field. Too much jargon can confuse newcomers, so use simple langauge and define all terms here.

Hang on to your README, you'll use it in Section 3, when you get your Group's Website and Repo online.
Hang on to your `README`, you'll use it in Section 3, when you get your Group's Website and Repo online.