Skip to content

Commit 6ca33bb

Browse files
committed
Community guidelines added
1 parent 46d6d5c commit 6ca33bb

File tree

7 files changed

+196
-0
lines changed

7 files changed

+196
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at test@test.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to this Project
2+
3+
Any contributions to this repository in the form of bug reports, bug fix, suggestions and feature requests
4+
are warmly welcomed as long as it does not hamper the tests and coverage report.
5+
6+
7+
## Getting Started
8+
9+
Follow the following steps to get started contributing to this project.
10+
11+
1. Fork the repository on GitHub.
12+
2. Clone your fork locally:
13+
14+
git clone https://github.com/your_username_here/django-bootstrap-datepicker-plus.git
15+
cd django-bootstrap-datepicker-plus
16+
git checkout -b name-of-your-bugfix-or-feature
17+
18+
3. Create a virtual environment of your choice and activate it.
19+
4. Install the dependencies via pip and run the migrations for demo_project.
20+
21+
npm run pip-install
22+
npm run migrate
23+
24+
5. Now you can run the demo_project on localhost:8000 to see the changes you make in action real-time.
25+
26+
npm run demo
27+
28+
29+
## Testing
30+
31+
1. Run the tests by the following command.
32+
33+
npm run test
34+
35+
2. See the coverage report by the following command.
36+
37+
npm run coverage
38+
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Setup Information (please complete the following information):**
24+
- OS: [e.g. Windows 10]
25+
- Browser [e.g. chrome, safari]
26+
- Browser version [e.g. 22]
27+
- Python version [e.g. 3.7]
28+
- Django version [e.g. 2.1]
29+
- Bootstrap version [e.g. 3/4]
30+
- jQuery version [e.g. 1.7.1]
31+
32+
**Additional context**
33+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Custom issue template
3+
about: Report something not surely a bug or any troubles using the package.
4+
5+
---
6+
7+
**Describe the problem**
8+
A clear and concise description of what the scenario is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Console errors**
21+
- No error on django console.
22+
- No error on JavaScript console.
23+
24+
**Paste-bin**
25+
The page is showing up but the date-picker calendar is not. The paste-bin link
26+
of the HTML source of the page is http://...
27+
28+
**Setup Information (please complete the following information):**
29+
- OS: [e.g. Windows 10]
30+
- Browser [e.g. chrome, safari]
31+
- Browser version [e.g. 22]
32+
- Python version [e.g. 3.7]
33+
- Django version [e.g. 2.1]
34+
- Bootstrap version [e.g. 3/4]
35+
- jQuery version [e.g. 1.7.1]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# PR Description
2+
3+
## Purpose
4+
_Describe the problem or feature in addition to a link to the issues._
5+
6+
## Approach
7+
_How does this change address the problem?_
8+
9+
#### Issues solved in this PR
10+
- [x] Issue 1
11+
- [x] Issue 2
12+
13+
#### What has Changed
14+
- Change 1
15+
- Change 2
16+
17+
#### Blog Posts
18+
- [How to Pull Request](https://github.com/flexyford/pull-request-template) Github Repo with Learning focused Pull Request Template.

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,12 @@ as an option (see end_date in the example).
218218
If both are specified then the moment format in options will take precedence.
219219

220220

221+
Contributing
222+
------------
223+
224+
- `CONTRIBUTING.md <https://github.com/monim67/django-bootstrap-datepicker-plus/blob/master/.github/CONTRIBUTING.md>`__.
225+
- `CODE_OF_CONDUCT.md <https://github.com/monim67/django-bootstrap-datepicker-plus/blob/master/.github/CODE_OF_CONDUCT.md>`__.
226+
221227
License
222228
-------
223229

0 commit comments

Comments
 (0)