feat: add documentations and travis config (#3)
This commit is contained in:
committed by
GitHub
parent
2cea1bdccc
commit
aa131b94d6
74
.github/CODE_OF_CONDUCT.md
vendored
Normal file
74
.github/CODE_OF_CONDUCT.md
vendored
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
|
contributors and maintainers pledge to making participation in our project and
|
||||||
|
our community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity and
|
||||||
|
orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
|
advances
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or electronic
|
||||||
|
address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
|
behavior and are expected to take appropriate and fair corrective action in
|
||||||
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers 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, or to ban temporarily or
|
||||||
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies both within project spaces and in public spaces
|
||||||
|
when an individual is representing the project or its community. Examples of
|
||||||
|
representing a project or community include using an official project e-mail
|
||||||
|
address, posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event. Representation of a project may be
|
||||||
|
further defined and clarified by project maintainers.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported by contacting the project team at team@freecodecamp.org. All
|
||||||
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||||
|
Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||||
|
faith may face temporary or permanent repercussions as determined by other
|
||||||
|
members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
|
available at [http://contributor-covenant.org/version/1/4][version]
|
||||||
|
|
||||||
|
[homepage]: http://contributor-covenant.org
|
||||||
|
[version]: http://contributor-covenant.org/version/1/4/
|
18
.github/ISSUE_TEMPLATE.md
vendored
Normal file
18
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<!-- NOTE: If you're reporting a security issue, don't create a GitHub issue. Instead, email security@freecodecamp.org. We will look into it immediately. -->
|
||||||
|
|
||||||
|
#### Describe your problem and - if possible - how to reproduce it
|
||||||
|
|
||||||
|
|
||||||
|
#### Add a Link to the page with the problem
|
||||||
|
|
||||||
|
|
||||||
|
#### Tell us about your browser and operating system
|
||||||
|
|
||||||
|
* Browser Name:
|
||||||
|
* Browser Version:
|
||||||
|
* Operating System:
|
||||||
|
|
||||||
|
|
||||||
|
#### If possible, add a screenshot here
|
||||||
|
|
||||||
|
|
32
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
32
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
<!-- freeCodeCamp Pull Request Template -->
|
||||||
|
|
||||||
|
<!-- IMPORTANT Please review https://github.com/freeCodeCamp/freeCodeCamp/blob/staging/CONTRIBUTING.md for detailed contributing guidelines -->
|
||||||
|
<!-- Help with PRs can be found at https://gitter.im/FreeCodeCamp/Contributors -->
|
||||||
|
<!-- Make sure that your PR is not a duplicate -->
|
||||||
|
|
||||||
|
#### Pre-Submission Checklist
|
||||||
|
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply. -->
|
||||||
|
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
|
||||||
|
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||||
|
- [ ] Your pull request targets the `staging` branch of freeCodeCamp.
|
||||||
|
- [ ] Branch starts with either `fix/`, `feature/`, or `translate/` (e.g. `fix/signin-issue`)
|
||||||
|
- [ ] You have only one commit (if not, [squash](http://forum.freecodecamp.org/t/how-to-squash-multiple-commits-into-one-with-git/13231) them into one commit).
|
||||||
|
- [ ] All new and existing tests pass the command `npm test`. Use `git commit --amend` to amend any fixes.
|
||||||
|
|
||||||
|
#### Type of Change
|
||||||
|
<!-- What type of change does your code introduce? After creating the PR, tick the checkboxes that apply. -->
|
||||||
|
- [ ] Small bug fix (non-breaking change which fixes an issue)
|
||||||
|
- [ ] New feature (non-breaking change which adds new functionality)
|
||||||
|
- [ ] Breaking change (fix or feature that would change existing functionality)
|
||||||
|
- [ ] Add new translation (feature adding new translations)
|
||||||
|
|
||||||
|
#### Checklist:
|
||||||
|
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply. -->
|
||||||
|
<!-- If you're unsure about any of these, don't hesitate to ask in the Contributors room linked above. We're here to help! -->
|
||||||
|
- [ ] Tested changes locally.
|
||||||
|
- [ ] Addressed currently open issue (replace XXXXX with an issue no in next line)
|
||||||
|
|
||||||
|
Closes #XXXXX
|
||||||
|
|
||||||
|
#### Description
|
||||||
|
<!-- Describe your changes in detail -->
|
10
.travis.yml
Normal file
10
.travis.yml
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
language: node_js
|
||||||
|
|
||||||
|
node_js:
|
||||||
|
- 'lts/*'
|
||||||
|
|
||||||
|
cache:
|
||||||
|
directories:
|
||||||
|
- node_modules
|
||||||
|
|
||||||
|
sudo: false
|
0
docs/CONTRIBUTING.md
Normal file
0
docs/CONTRIBUTING.md
Normal file
Reference in New Issue
Block a user