-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
UPDATED 12-09-2021 UPDATED 12-10-2021 UPDATED 12-10-2021 UPDATED 12-10-2021 UPDATED 12-11-2021 Update README.md ADDED 10.18.2021 A list of predefined extraction modules for global news sources. ADDED 10.18.2021 A list of predefined extraction modules for global news sources. UPDATED 11-20-2021 Adding additional sources UPDATED 11-20-2021 Update predefined_extraction_sources.md Update predefined_extraction_sources.md ADDED ON 11-29-2021 ADDED on 11-29-2020 ADDED ON 11-29-2021 ADDED ON 11-29-2021 ADDED ON 11-29-2021 ADDED ON 11-29-2021 ADDED ON 11-29-2021 ADDED 11-29-2021 UPDATED 12-09-2021
- Loading branch information
1 parent
45fab83
commit 03b6267
Showing
8 changed files
with
765 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
[NewsHound project](mailto:newshoundproject@gmail.com?subject=[GitHub]%20newshound%20project%20code%20of%20conduct%20issue). | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.0, available at | ||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
enforcement ladder](https://github.com/mozilla/diversity). | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
https://www.contributor-covenant.org/faq. Translations are available at | ||
https://www.contributor-covenant.org/translations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
## Contributing to NewsHound | ||
|
||
We're glad that you want to contribute to the <i>NewsHound</i> project! This document will help answer common questions you may have during your first contribution or whether it is, such as: | ||
|
||
|
||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing new features | ||
- Becoming a maintainer | ||
|
||
|
||
## Submitting Issues | ||
|
||
Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. | ||
|
||
At <i>NewsHound</i> we use GitHub to track all project issues. Report by [opening a new issue](https://github.com/johnbumgarner/newshound/issues/new/choose) for the <i>NewsHound</i> project. | ||
|
||
Write bug or issue reports with detail, background, and sample code: | ||
|
||
**Great Bug Reports** tend to have: | ||
|
||
- A quick summary and/or background | ||
- Steps to reproduce | ||
- Be specific! | ||
- Give sample code if you can. | ||
- What you expected would happen | ||
- What actually happens | ||
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) | ||
|
||
|
||
## Pull Requests | ||
|
||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: | ||
|
||
1. Fork the repo and create your branch from `master`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
6. Issue that pull request! | ||
|
||
|
||
## Reporting a Vulnerability | ||
|
||
If you have found a security vulnerability in <i>NewsHound</i>, or a dependency use, please contact us on [Slack](https://newshoundsupport.slack.com) or via email me at [NewsHound project](mailto:newshoundproject@gmail.com?subject=[GitHub]%20newshound%20project%20security%20issue). | ||
|
||
Please join the `#newshound-project` channel and say that you believe you have found a security issue. | ||
One of the Wordhoard Support members will send you a direct message to understand the problem. Once the problem is understood a newly created private channel | ||
will be created by the Member and you will be invited to explain the problem further. | ||
|
||
Please provide a [concise reproducible test case](http://sscce.org/) and describe what results you are seeing and what results you expect. | ||
|
||
|
||
## Developer Certification of Origin (DCO) | ||
|
||
Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired. | ||
|
||
Wordhoard uses the [MIT License](http://choosealicense.com/licenses/mit/) to strike a balance between open contribution and allowing you to use the Wordhoard package in other projects. | ||
|
||
The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are licensing and agrees to them. Sometimes the copyright holder isn't the contributor, such as when the contributor is doing work on behalf of a company. | ||
|
||
To make a good faith effort to ensure these criteria are met, Wordhoard requires the Developer Certificate of Origin (DCO) process to be followed. | ||
|
||
The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO. | ||
|
||
``` | ||
Developer's Certificate of Origin 1.1 | ||
By making a contribution to this project, I certify that: | ||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
(b) The contribution is based upon previous work that, to the | ||
best of my knowledge, is covered under an appropriate open | ||
source license and I have the right under that license to | ||
submit that work with modifications, whether created in whole | ||
or in part by me, under the same open source license (unless | ||
I am permitted to submit under a different license), as | ||
Indicated in the file; or | ||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including | ||
all personal information I submit with it, including my | ||
sign-off) is maintained indefinitely and may be redistributed | ||
consistent with this project or the open source license(s) | ||
involved. | ||
``` | ||
|
||
# DCO Sign-Off Methods | ||
|
||
The DCO requires a sign-off message in the following format appear on each commit in the pull request: | ||
|
||
``` | ||
Signed-off-by: Super Coder <supercoder@somedomain.com> | ||
``` | ||
|
||
The DCO text can either be manually added to your commit body, or you can add either -s or --signoff to your usual git commit commands. If you are using the GitHub UI to make a change you can add the sign-off message directly to the commit message when creating the pull request. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running git commit --amend -s. If you've pushed your changes to GitHub already you'll need to force push your branch after this with git push -f. | ||
|
||
## NewsHound Obvious Fix Policy | ||
|
||
Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without signing the contribution for the DCO. | ||
|
||
As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. Assuming the change does not affect functionality, some common obvious fix examples include the following: | ||
|
||
Spelling / grammar fixes | ||
Typo correction, white space and formatting changes | ||
Comment clean up | ||
Bug fixes that change default return values or error codes stored in constants | ||
Adding logging messages or debugging output | ||
Changes to 'metadata' files like .gitignore, build scripts, etc. | ||
Moving source files from one directory or package to another | ||
Whenever you invoke the "obvious fix" rule, please say so in your commit message: | ||
|
||
------------------------------------------------------------------------ | ||
commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5 | ||
Author: Super Coder <supercoder@somedomain.com> | ||
Date: Fri Aug 13 14:00:40 2021 -0500 | ||
|
||
Fix typo in the README. | ||
|
||
Obvious fix. | ||
|
||
------------------------------------------------------------------------ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
custom: https://www.buymeacoffee.com/johnbumgarner |
Oops, something went wrong.