Skip to content

Commit

Permalink
chore: use markdown project files (#30)
Browse files Browse the repository at this point in the history
* chore: add code of conduct and issue templates
* chore: update workflow trigger branch name
  • Loading branch information
lgpage authored Feb 16, 2023
1 parent cec2326 commit 2dd1be1
Show file tree
Hide file tree
Showing 18 changed files with 395 additions and 260 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

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

**Installed Packages**
The following Python and installed packages versions being used:

- Python:
- Cython:
- Pytest:
- Pytest-cython:

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

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

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**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.
4 changes: 2 additions & 2 deletions .github/workflows/python-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ name: Check

on:
push:
branches: ["master"]
branches: ["main"]

pull_request:
branches: ["master"]
branches: ["main"]

jobs:
build:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/python-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ name: Test

on:
push:
branches: ["master"]
branches: ["main"]

pull_request:
branches: ["master"]
branches: ["main"]

jobs:
build:
Expand Down
49 changes: 49 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Changelog

## 0.2.1

The full list of merged changes is:

- #26: fix: pytest_collect_file to take into account pytest fspath deprecation in Node constructors
- #29: chore: use GitHub actions instead of Travis

Special thanks to the following contributors that made this release possible:

- @AlenkaF
- @shvenkat

## 0.2.0

The full list of merged changes is:

- #11: Update tests
- #15, #17: Dropped support for Python 2, added support for Python 3.6+
- #18: New patched pyimport implementation, maintaining better compatibility with the installed pytest version
- #19: Rework how test collection works, making it possible to directly specify .pyx files to run, and reporting
tests as being from the .pyx files as opposed to the compiled extension modules
- #20: Fix handling of cython generated autotestdicts; prevents running the same tests repeatedly, and adds better
reporting of test line numbers
- #21: Add CI job with Windows
- #22: Various documentation improvements

Special thanks to the following contributors that made this release possible:

- @embray

## 0.1.1

The full list of merged changes is:

- #5: Fix DoctestModule deprecated error
- #6: Fix typo from #5
- #7: Fix support for relative imports
- #9: Maintain backwards compatibility for pytest 4.x

Special thanks to the following contributors that made this release possible:

- @embray
- @thrasibule

## 0.1.0

First release on PyPI (2016-04-17)
55 changes: 0 additions & 55 deletions CHANGELOG.rst

This file was deleted.

128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
84 changes: 84 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

## Bug reports

When [reporting a bug](https://github.com/lgpage/pytest-cython/issues)
please include:

- Your operating system name and version.
- The `cython` and `pytest` versions you are using
- Detailed steps to reproduce the bug.
- Any other details about your local setup that might be helpful in troubleshooting.

## Documentation improvements

`pytest-cython` could always use more documentation, whether as part of the official `pytest-cython` docs, in
docstrings, or even on the web in blog posts, articles, and such.

## Feature requests and feedback

The best way to send feedback is to [file an issue](https://github.com/lgpage/pytest-cython/issues). If you are
proposing a new feature:

- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)

## Development

To set up `pytest-cython` for local development:

1. Fork [pytest-cython](https://github.com/lgpage/pytest-cython) (look for the \"fork\" button).

2. Clone your fork locally:

```shell
git clone [email protected]:your_name_here/pytest-cython.git
```

3. Create a branch for local development:

```shell
git checkout -b name-of-your-bugfix-or-feature
```

4. When you're done making changes, run all the checks and tests with the [nox](https://tox.wiki/en/latest) command:
```shell
nox
```
5. Commit your changes and push your branch to GitHub:
```shell
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```
6. Submit a pull request through the GitHub website.
## Pull Request Guidelines
If you need some code review or feedback while you're developing the code just make the pull request.

Before merging, you should:

1. Update the documentation when there's new API, functionality etc.
2. Add a note to `CHANGELOG.rst` about the changes.
## Tips
To list all [nox](https://tox.wiki/en/latest) tasks:
```shell
nox --list
```
To run a subset of tests use one of the task from the above list, for example:
```shell
nox --session "test(cython='0.29', python='3.9', pytest='7')"
```
Loading

0 comments on commit 2dd1be1

Please sign in to comment.