Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit aac6154

Browse files
author
Kevin Morris
committedFeb 20, 2017
Adds Code of Conduct and contribution guidelines
1 parent 18db6a6 commit aac6154

File tree

3 files changed

+154
-0
lines changed

3 files changed

+154
-0
lines changed
 

‎CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing to jQuery Form
2+
3+
Want to contribute to jQuery Form? That's great! Contributions are most welcome!
4+
Here are a couple of guidelines that will help you contribute. Before we get started: Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming place for **everyone** to contribute to. By participating in this project you agree to abide by its terms.
5+
6+
#### Overview
7+
* [Contribution workflow](#contribution-workflow)
8+
* [Reporting a bug](#reporting-a-bug)
9+
* [Contributing to an existing issue](#contributing-to-an-existing-issue)
10+
* [Feature Requests](#feature-requests)
11+
* [Additional info](#additional-info)
12+
13+
## Contribution workflow
14+
15+
* Fork the repository in GitHub with the `Fork` button.
16+
* Switch to a new branch (ie. `new-feature`), and work from there:
17+
`git checkout -b new-feature`
18+
* Make your feature addition or bug fix.
19+
* Send a pull request (PR). Bonus points for topic branches.
20+
* Please make sure all of your commits are atomic (one feature per commit).
21+
* Use sensible commit messages.
22+
* Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
23+
24+
```shell
25+
$ git commit -m "A brief summary of the commit"
26+
>
27+
> A paragraph describing what changed and its impact."
28+
```
29+
30+
* If your PR fixes a separate issue number, include it in the commit message.
31+
32+
### Things to keep in mind
33+
* Smaller PRs are likely to be merged more quickly than bigger changes.
34+
* If it is a useful PR it **will** get merged in eventually.
35+
* This project is using [Semantic Versioning 2.0.0](http://semver.org/)
36+
37+
## Reporting a bug
38+
39+
So you've found a bug, and want to help us fix it? Before filing a bug report, please double-check the bug hasn't already been reported. You can do so [on our issue tracker](https://github.com/jquery-form/form/issues?q=is%3Aopen+is%3Aissue). If something hasn't been raised, you can go ahead and create a new issue with the following information:
40+
41+
* Which version of the plugin are you using?
42+
* How can the error be reproduced?
43+
* If possible, include a link to a [JSFiddle](https://jsfiddle.net/) or [CodePen](https://codepen.io/) example of the error.
44+
45+
If you want to be really thorough, there is a great overview on Stack Overflow of [what you should consider when reporting a bug](https://stackoverflow.com/questions/240323/how-to-report-bugs-the-smart-way).
46+
47+
It goes without saying that you're welcome to help investigate further and/or find a fix for the bug. If you want to do so, just mention it in your bug report and offer your help!
48+
49+
## Contributing to an existing issue
50+
51+
### Finding an issue to work on
52+
53+
We've got a few open issues and are always glad to get help on that front. You can view the list of issues [here](https://github.com/jquery-form/form/issues). (Here's [a good article](https://medium.freecodecamp.com/finding-your-first-open-source-project-or-bug-to-work-on-1712f651e5ba) on how to find your first bug to fix).
54+
55+
Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.
56+
57+
If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.
58+
59+
Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?
60+
And if at any point you get stuck: don't hesitate to ask for help.
61+
62+
### Making your contribution
63+
64+
We've outlined the contribution workflow [here](#contribution-workflow). If you're a first-timer, don't worry! GitHub has a ton of guides to help you through your first pull request: You can find out more about pull requests [here](https://help.github.com/articles/about-pull-requests/) and about creating a pull request [here](https://help.github.com/articles/creating-a-pull-request/).
65+
66+
## Feature Requests
67+
* You can _request_ a new feature by [submitting an issue](https://github.com/jquery-form/form/issues).
68+
* If you would like to _implement_ a new feature:
69+
* For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
70+
* **Small Features** can be crafted and directly [submitted as a Pull Request](#contribution-workflow).
71+
72+
## Additional info
73+
74+
Especially if you're a newcomer to Open Source and you've found some little bumps along the way while contributing, we recommend you write about them. [Here](https://medium.freecodecamp.com/new-contributors-to-open-source-please-blog-more-920af14cffd)'s a great article about why writing about your experience is important; this will encourage other beginners to try their luck at Open Source, too!

‎README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ The jQuery Form Plugin allows you to easily and unobtrusively upgrade HTML forms
55

66
No special markup is needed, just a normal form. Submitting a form with AJAX doesn't get any easier than this!
77

8+
##Community
9+
Want to contribute to jQuery Form? Awesome! See [CONTRIBUTING](CONTRIBUTING.md) for more information.
10+
11+
###Code of Conduct
12+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming place for **everyone** to contribute to. By participating in this project you agree to abide by its terms.
13+
814
---
915

1016
##API

0 commit comments

Comments
 (0)
Please sign in to comment.