-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
215 additions
and
0 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,76 @@ | ||
# 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, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, 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 [email protected]. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
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,139 @@ | ||
# Contributing | ||
|
||
We'd love for you to contribute to our source code and to make our project even better than it is | ||
today! Here are the guidelines we'd like you to follow: | ||
|
||
* [Code of Conduct](#coc) | ||
* [Questions and Problems](#question) | ||
* [Issues and Bugs](#issue) | ||
* [Feature Requests](#feature) | ||
* [Issue Submission Guidelines](#submit) | ||
* [Pull Request Submission Guidelines](#submit-pr) | ||
* [Signing the CLA](#cla) | ||
|
||
## <a name="coc"></a> Code of Conduct | ||
|
||
Help us keep our community open-minded and inclusive. Please read and follow our [Code of Conduct][coc]. | ||
|
||
## <a name="requests"></a> Questions, Bugs, Features | ||
|
||
### <a name="question"></a> Got a Question or Problem? | ||
|
||
Do not open issues for general support questions as we want to keep GitHub issues for bug reports | ||
and feature requests. You've got much better chances of getting your question answered on dedicated | ||
support platforms, the best being [Stack Overflow][stackoverflow]. | ||
|
||
Stack Overflow is a much better place to ask questions since: | ||
|
||
- there are thousands of people willing to help on Stack Overflow | ||
- questions and answers stay available for public viewing so your question / answer might help | ||
someone else | ||
- Stack Overflow's voting system assures that the best answers are prominently visible. | ||
|
||
To save your and our time, we will systematically close all issues that are requests for general | ||
support and redirect people to the section you are reading right now. | ||
|
||
### <a name="issue"></a> Found an Issue or Bug? | ||
|
||
If you find a bug in the source code, you can help us by submitting an issue to our | ||
[GitHub Repository][github]. Even better, you can submit a Pull Request with a fix. | ||
|
||
### <a name="feature"></a> Missing a Feature? | ||
|
||
You can request a new feature by submitting an issue to our [GitHub Repository][github-issues]. | ||
|
||
If you would like to implement a new feature then consider what kind of change it is: | ||
|
||
* **Major Changes** that you wish to contribute to the project should be discussed first in an | ||
[GitHub issue][github-issues] that clearly outlines the changes and benefits of the feature. | ||
* **Small Changes** can directly be crafted and submitted to the [GitHub Repository][github] | ||
as a Pull Request. See the section about [Pull Request Submission Guidelines](#submit-pr). | ||
|
||
## <a name="submit"></a> Issue Submission Guidelines | ||
|
||
Before you submit your issue search the archive, maybe your question was already answered. | ||
|
||
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize | ||
the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. | ||
|
||
The "[new issue][github-new-issue]" form contains a number of prompts that you should fill out to | ||
make it easier to understand and categorize the issue. | ||
|
||
## <a name="submit-pr"></a> Pull Request Submission Guidelines | ||
|
||
By submitting a pull request for a code or doc contribution, you need to have the right | ||
to grant your contribution's copyright license to ProcessOne. Please check [ProcessOne CLA][cla] | ||
for details. | ||
|
||
Before you submit your pull request consider the following guidelines: | ||
|
||
* Search [GitHub][github-pr] for an open or closed Pull Request | ||
that relates to your submission. You don't want to duplicate effort. | ||
* Make your changes in a new git branch: | ||
|
||
```shell | ||
git checkout -b my-fix-branch master | ||
``` | ||
* Test your changes and, if relevant, expand the automated test suite. | ||
* Create your patch commit, including appropriate test cases. | ||
* If the changes affect public APIs, change or add relevant documentation. | ||
* Commit your changes using a descriptive commit message. | ||
|
||
```shell | ||
git commit -a | ||
``` | ||
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. | ||
|
||
* Push your branch to GitHub: | ||
|
||
```shell | ||
git push origin my-fix-branch | ||
``` | ||
|
||
* In GitHub, send a pull request to `master` branch. This will trigger the continuous integration and run the test. | ||
We will also notify you if you have not yet signed the [contribution agreement][cla]. | ||
|
||
* If you find that the continunous integration has failed, look into the logs to find out | ||
if your changes caused test failures, the commit message was malformed etc. If you find that the | ||
tests failed or times out for unrelated reasons, you can ping a team member so that the build can be | ||
restarted. | ||
|
||
* If we suggest changes, then: | ||
|
||
* Make the required updates. | ||
* Test your changes and test cases. | ||
* Commit your changes to your branch (e.g. `my-fix-branch`). | ||
* Push the changes to your GitHub repository (this will update your Pull Request). | ||
|
||
You can also amend the initial commits and force push them to the branch. | ||
|
||
```shell | ||
git rebase master -i | ||
git push origin my-fix-branch -f | ||
``` | ||
|
||
This is generally easier to follow, but separate commits are useful if the Pull Request contains | ||
iterations that might be interesting to see side-by-side. | ||
|
||
That's it! Thank you for your contribution! | ||
## <a name="cla"></a> Signing the Contributor License Agreement (CLA) | ||
Upon submitting a Pull Request, we will ask you to sign our CLA if you haven't done | ||
so before. It's a quick process, we promise, and you will be able to do it all online | ||
You can read [ProcessOne Contribution License Agreement][cla] in PDF. | ||
This is part of the legal framework of the open-source ecosystem that adds some red tape, | ||
but protects both the contributor and the company / foundation behind the project. It also | ||
gives us the option to relicense the code with a more permissive license in the future. | ||
[coc]: https://github.com/processone/p1_pgsql/blob/master/CODE_OF_CONDUCT.md | ||
[stackoverflow]: https://stackoverflow.com/ | ||
[github]: https://github.com/processone/p1_pgsql | ||
[github-issues]: https://github.com/processone/p1_pgsql/issues | ||
[github-new-issue]: https://github.com/processone/p1_pgsql/issues/new | ||
[github-pr]: https://github.com/processone/p1_pgsql/pulls | ||
[cla]: https://www.process-one.net/resources/ejabberd-cla.pdf | ||
[license]: https://github.com/processone/p1_pgsql/blob/master/EPLICENSE |