Skip to content

Commit

Permalink
Merge pull request #102 from asfaltboy/release/1.1.1
Browse files Browse the repository at this point in the history
Release 1.1.1
  • Loading branch information
asfaltboy authored Jan 28, 2019
2 parents 92fa398 + 41221f7 commit 34b496b
Show file tree
Hide file tree
Showing 6 changed files with 200 additions and 3 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Details (please complete the following information):**
- OS: [e.g. iOS]
- Python version [e.g 3.7]
- Django version [e. 2.1]
- django-advanced-filters version [e.g 1.1]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here, including traceback and additional log files.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
Changelog
=========

1.1.1 - CHANGELOG rendering is hard
-----------------------------------

This release is for fixing the bug when installing with specific environment (
locale that defaults to CP-1252).

Bug fixes
~~~~~~~~~

- Add encoding='utf-8' to open() in setup.py (Merge 2fe81aa)

Docs / Other
~~~~~~~~~~~~

- add CONTRIBUTING.rst with common processes (Merge ee7907e)
- Update issue templates (Merge ee7907e)

Contributors
~~~~~~~~~~~~

- Rebecca Turner
- Pavel Savchenko


1.1.0 - The future is bright
----------------------------

Expand Down
123 changes: 123 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
Contributing
============

When contributing to this repository, please first discuss the change
you wish to make via issue, email, or any other method with the owners
of this repository before making a change.

Please note we have a code of conduct, please follow it in all your
interactions with the project.

Pull Request Process
--------------------

1. Ensure that your commit messages follow `the conventional-commits
spec <https://www.conventionalcommits.org/en/v1.0.0-beta.2/#specification>`__.
2. Remember to run the test suite with
`tox <https://tox.readthedocs.io/en/latest/>`__. Do note that all
inclusive version matrix requires 6 versions of Python and 7 versions
of Django to be installed and takes quite a long time. For most
changes, we encourage you to run the tests on a single version while
developing and leaving the full test matrix for CI.
3. Update the README.rst with details of changes to the interface, this
includes new environment variables, exposed ports, useful file
locations and container parameters.
4. You may merge the Pull Request in once you have the sign-off of one
other developer, or if you do not have permission to do that, you may
request the reviewer to merge it for you.

Release process
---------------

1. Prepeare the changelog and amend the CHANGELOG.rst
2. Increase the version numbers in any examples files and the README.rst
to the new version that this Pull Request would represent. The
versioning scheme we use is `SemVer <http://semver.org/>`__.
3. Test your changes with `twine and
test-pypi <https://twine.readthedocs.io/en/latest/#using-twine>`__
before pushing to the official pypi.org (versions on PyPI cannot be
deleted so we MUST make sure it works first to avoid the immediate
hotfix).

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 [INSERT EMAIL ADDRESS].
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 <http://contributor-covenant.org>`__, version 1.4, available at
`http://contributor-covenant.org/version/1/4 <http://contributor-covenant.org/version/1/4/>`__
2 changes: 1 addition & 1 deletion advanced_filters/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.1.0'
__version__ = '1.1.1'
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from setuptools import setup, find_packages
import os
import sys
import io

from advanced_filters import __version__

Expand Down Expand Up @@ -34,9 +35,9 @@ def get_full_description():
readme = 'README.rst'
changelog = 'CHANGELOG.rst'
base = os.path.dirname(__file__)
with open(os.path.join(base, readme)) as readme:
with io.open(os.path.join(base, readme), encoding='utf-8') as readme:
README = readme.read()
with open(os.path.join(base, changelog)) as changelog:
with io.open(os.path.join(base, changelog), encoding='utf-8') as changelog:
CHANGELOG = changelog.read()
return '%s\n%s' % (README, CHANGELOG)

Expand Down

0 comments on commit 34b496b

Please sign in to comment.