CONTRIBUTING.md 3.94 KB
Newer Older
Russell Jarvis's avatar
Russell Jarvis committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72


# Contributing to Open Source Science Accessibility Project 
This content is based upon a pre-established [standard](https://github.com/github/opensource.guide) that developers in this project adhere to.


We're excited to hear and learn from you.

We've put together the following guidelines to help you figure out where you can best be helpful.

## Table of Contents

0. [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
0. [Ground rules & expectations](#ground-rules--expectations)
0. [How to contribute](#how-to-contribute)
0. [Style guide](#style-guide)
0. [Setting up your environment](#setting-up-your-environment)
0. [Contribution review process](#contribution-review-process)
0. [Community](#community)

## Types of contributions we're looking for
There are many ways you can directly contribute to the guides (in descending order of need):

* maintance of scraping code.
* science writing
* machine learning and analysis
* integration between science writing and analysis

Interested in making a contribution? Read on!

## Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):
* Anyone who makes constructive contributions, big or small, deserves credit. It is helpful, but not necessary 
if they can initiate self stating of affiliations in code files, and documents, were appropriate.
* Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
* Open Source Guides are released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
* If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
* When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

## How to contribute

If you'd like to contribute, start by searching through the [issues](https://github.com/github/opensource.guide/issues) and [pull requests](https://github.com/github/opensource.guide/pulls) to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:
* **If your contribution is minor,** such as a typo fix, open a pull request.
* **If your contribution is major,** such as a new guide, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

## Style guide
If you're writing content, see the [style guide](./docs/styleguide.md) to help your prose match the rest of the Guides.

## Setting up your environment

Try to build within the Docker container, hyperlinked in the README.md

## Community

Discussions about the Science Accessibilty Project take place on this repository's [Issues](https://github.com/russelljjarvis/ScienceAccessibility/issues).

Although public conversation is good as it means everybody can benefit and learn from the conversation. All communication is merited, including private communication.

References:
This project is built on top of heaps of FOS Software. Chief among those are [text-stat](https://github.com/shivam5992/textstat), NLTK, and GoogleScrape.

Which employs algorithms like:
Kincaid, J. Peter, et al. "Derivation of new readability formulas (automated readability index, fog count and flesch reading ease formula) for navy enlisted personnel." (1975).

## Other Relevant Links:

https://stackoverflow.com/questions/32429445/is-web-scraping-allowed?fbclid=IwAR1noACRESdM1zld2zKJZ019ZB5CUFj2Xw38hh4fsrJXwZINsE0I09uT2_A

https://www.copyright.gov/fair-use/more-info.html