Skip to content

Commit 4004234

Browse files
Daniel XuDaniel Xu
Daniel Xu
authored and
Daniel Xu
committed
add-templates
1 parent b5396e8 commit 4004234

File tree

4 files changed

+174
-26
lines changed

4 files changed

+174
-26
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
Thank you for contributing!
3+
4+
Have a usage question?
5+
======================
6+
Questions will be closed without comment. Here are some resources to get help:
7+
8+
- Read the README: https://github.com/dockyard/styleguides
9+
!! ADD MORE HELP RESOURCES HERE !!
10+
11+
Think you found a bug?
12+
======================
13+
The best bug report is a failing test in the repository as a pull request. Otherwise, please use the "BUG REPORT" template below.
14+
15+
16+
Have a feature request?
17+
=======================
18+
Remove the template from below and provide thoughtful commentary *and code samples* on what this feature means for your product. What will it allow you to do that you can't do today? How will it make current work-arounds straightforward? What potential bugs and edge cases does it help to avoid? etc. Please keep it product-centric.
19+
-->
20+
21+
<!-- BUG TEMPLATE -->
22+
## Version
23+
<!-- Put the version you want to report a bug for here -->
24+
25+
## Test Case
26+
<!-- Please provide a (link to) a reduced test case -->
27+
28+
## Steps to reproduce
29+
<!-- With the reduced test case, how do you reproduce the error condition? -->
30+
31+
## Expected Behavior
32+
<!-- Describe here what you expected to happen -->
33+
34+
## Actual Behavior
35+
<!-- Describe here what actually happened -->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!--
2+
Thank you for contributing!
3+
4+
Here are a few things that will increase the chance that your pull request will get accepted:
5+
- Write tests, preferably in a test driven style.
6+
- Add documentation for the changes you made.
7+
- Follow our styleguide: https://github.com/dockyard/styleguides
8+
-->
9+
10+
<!-- If this pull request addresses an issue please provide the issue number here -->
11+
Closes # .
12+
13+
## Changes proposed in this pull request
14+
<!-- Please describe here what this pull request changes -->

‎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 at [email protected]. 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: 51 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,60 @@
1-
# Contribution Guidelines #
1+
# How to contribute
22

3-
## Submitting a new issue ##
3+
## Improve documentation
44

5-
If you need to open a new issue you *must* provide the following:
5+
We are always looking to improve our documentation. If at some moment you are
6+
reading the documentation and something is not clear, or you can't find what you
7+
are looking for, then please open an issue with the repository. This gives us a
8+
chance to answer your question and to improve the documentation if needed.
69

7-
1. Version of Rails
10+
Pull requests correcting spelling or grammar mistakes are always welcome.
811

9-
Failure to include the aforementioned requirements will result in the
10-
issue being closed.
12+
## Found a bug?
1113

12-
If you want to ensure that your issue gets fixed *fast* you should
13-
attempt to reproduce the issue in an isolated example application that
14-
you can share.
14+
Please try to answer at least the following questions when reporting a bug:
1515

16-
## Making a pull request ##
16+
- Which version of the project did you use when you noticed the bug?
17+
- How do you reproduce the error condition?
18+
- What happened that you think is a bug?
19+
- What should it do instead?
1720

18-
If you'd like to submit a pull request please adhere to the following:
21+
It would really help the maintainers if you could provide a reduced test case
22+
that reproduces the error condition.
1923

20-
1. Your code *must* be tested. Please TDD your code!
21-
2. No single-character variables
22-
3. Two-spaces instead of tabs
23-
4. Single-quotes instead of double-quotes unless you are using string
24-
interpolation or escapes.
25-
5. General Rails/Ruby naming conventions for files and classes
26-
6. *Do not* use Ruby 1.9 hash syntax
27-
7. *Do not* use Ruby 1.9 stubby proc syntax
28-
8. Follow Tim Pope's [model for git commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). This will make it
29-
much easier to generate change logs and navigate through the logs
24+
## Have a feature request?
3025

31-
Please note that you must adhere to each of the aforementioned rules.
32-
Failure to do so will result in an immediate closing of the pull
33-
request. If you update and rebase the pull request to follow the
34-
guidelines your pull request will be re-opened and considered for
35-
inclusion.
26+
Please provide some thoughful commentary and code samples on what this feature
27+
should do and why it should be added (your use case). The minimal questions you
28+
should answer when submitting a feature request should be:
29+
30+
- What will it allow you to do that you can't do today?
31+
- Why do you need this feature and how will it benefit other users?
32+
- Are there any drawbacks to this feature?
33+
34+
## Submitting a pull-request?
35+
36+
Here are some things that will increase the chance that your pull-request will
37+
get accepted:
38+
- Did you confirm this fix/feature is something that is needed?
39+
- Did you write tests, preferably in a test driven style?
40+
- Did you add documentation for the changes you made?
41+
- Did you follow our [styleguide](https://github.com/dockyard/styleguides)?
42+
43+
If your pull-request addresses an issue then please add the corresponding
44+
issue's number to the description of your pull-request.
45+
46+
# How to work with this project locally
47+
48+
## Installation
49+
50+
First clone this repository:
51+
52+
```sh
53+
git clone https://github.com/DockYard/postgres_ext.git
54+
```
55+
56+
<!-- Add further details on how to install the project here -->
57+
58+
## Running tests
59+
60+
<!-- Tell the user how to run the tests of your project -->

0 commit comments

Comments
 (0)