Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ repos:
hooks:
- id: flake8
args: [--max-line-length=119]
- repo: https://github.com/rvben/rumdl-pre-commit
rev: v0.1.4
hooks:
- id: rumdl
123 changes: 62 additions & 61 deletions CODE_OF_CONDUCT.md

Large diffs are not rendered by default.

57 changes: 14 additions & 43 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,44 @@
# All Contributions Welcome

It's not just about code. A successful software project requires documentation,
design skills, feedback and bug reports. The BeeWare community acknowledges
that all contributions are important - not just the ones that come as a pull
request on GitHub.
It's not just about code. A successful software project requires documentation, design skills, feedback and bug reports. The BeeWare community acknowledges that all contributions are important - not just the ones that come as a pull request on GitHub.

## First-time Contributors

If you're new to the project (or even entirely new to open source in general),
the best place to start is
[here](https://beeware.org/contributing/how/first-time/). Everyone can
contribute to open source, and we're here to show you how.
If you're new to the project (or even entirely new to open source in general), the best place to start is with our [first-time contributors guide](https://beeware.org/contributing/how/first-time/). Everyone can contribute to open source, and we're here to show you how.

## Code Contributions

Your code contributions are welcome! Please familiarize yourself with our
[Development Process](https://beeware.org/contributing/how/process/).
Your code contributions are welcome! Please familiarize yourself with our [Development Process](https://beeware.org/contributing/how/process/).

If you're looking for something to work on, and don't know where your effort would be welcome, try looking at the ticket tracker for a project of interest. There will usually be a couple of tickets with known problems; any ticket is a candidate for being fixed. Some tickets in particular will be tagged [up-for-grabs](https://github.com/search?q=user%3Abeeware+label%3Aup-for-grabs+is%3Aissue+is%3Aopen&type=)

If you're looking for something to work on, and don't know where your effort
would be welcome, try looking at the ticket tracker for a project of interest.
There will usually be a couple of tickets with known problems; any ticket is a
candidate for being fixed. Some tickets in particular will be tagged
[up-for-grabs](https://github.com/search?q=user%3Abeeware+label%3Aup-for-grabs+is%3Aissue+is%3Aopen&type=)
- this indicates that they are areas of particular interest where the project
would like contributions.

If you're a first time contributor, some tickets are also tagged as
[first-timers-only](https://github.com/search?q=user%3Abeeware+label%3Afirst-timers-only+is%3Aissue+is%3Aopen&type=).
These are special issues that have been selected because they're relatively
simple introductions to the project, and the BeeWare team will mentor any first
time contributor in committing a patch for one of these issues.
If you're a first time contributor, some tickets are also tagged as [first-timers-only](https://github.com/search?q=user%3Abeeware+label%3Afirst-timers-only+is%3Aissue+is%3Aopen&type=). These are special issues that have been selected because they're relatively simple introductions to the project, and the BeeWare team will mentor any first time contributor in committing a patch for one of these issues.

## Platform Usage

Do you use Windows or various flavours of Linux? Are you able to install a
project or application on your system? Did you run into any problems?
Do you use Windows or various flavours of Linux? Are you able to install a project or application on your system? Did you run into any problems?

If so, please update the documentation to show how you were able to get it to
work, or log an issue if you've found a bug that you can't fix.
If so, please update the documentation to show how you were able to get it to work, or log an issue if you've found a bug that you can't fix.

## Documentation

Is the documentation up to date? Do you think things could be worded
differently? Are there missing sections? Do you have an idea for a tutorial
that could be written? Please submit a Pull Request!
Is the documentation up to date? Do you think things could be worded differently? Are there missing sections? Do you have an idea for a tutorial that could be written? Please submit a Pull Request!

## Help translate and update our Website

Is there anything wrong or missing from our website? Please feel free to make
edits and submit a pull request!
Is there anything wrong or missing from our website? Please feel free to make edits and submit a pull request!

Want to help translate or update the content of this website? Visit the
translations section.
Want to help translate or update the content of this website? Visit the translations section.

## Build a real application!

Ultimately BeeWare is a set of tools for building applications. One of the best
ways to evaluate our progress is to see people build real-world applications
with the BeeWare tools. So if you've got an idea for an application you've
always wanted or needed - try to build it!
Ultimately BeeWare is a set of tools for building applications. One of the best ways to evaluate our progress is to see people build real-world applications with the BeeWare tools. So if you've got an idea for an application you've always wanted or needed - try to build it!

In the process of building that application, you'll likely find bugs, missing
features, or friction in the development process. Those problems can then be
turned into bug reports or patches.
In the process of building that application, you'll likely find bugs, missing features, or friction in the development process. Those problems can then be turned into bug reports or patches.

## Something else

If you've got your own idea for something, or if you don't see any tickets, or
you want to be mentored on a ticket, or you aren't sure how to proceed, contact
the project maintainers on Twitter or Discord. The project maintainers love
collaborating, especially with new contributors, and will gladly answer any
questions or walk you through any problems you may encounter.
If you've got your own idea for something, or if you don't see any tickets, or you want to be mentored on a ticket, or you aren't sure how to proceed, contact the project maintainers on Twitter or Discord. The project maintainers love collaborating, especially with new contributors, and will gladly answer any questions or walk you through any problems you may encounter.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@

![BeeWare Logo](https://beeware.org/static/images/brutus-270.png)

These are the GitHub Community Health files for the [BeeWare
Project](https://beeware.org).
These are the GitHub Community Health files for the [BeeWare Project](https://beeware.org).
25 changes: 6 additions & 19 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,17 @@
# Security Policy

The BeeWare Projects team is strongly committed to responsible reporting and
disclosure of security-related issues. As such, we’ve adopted and follow a set
of policies which conform to that ideal and are geared toward allowing us to
deliver timely security updates to the official distribution of BeeWare tools,
as well as to third-party distributions.
The BeeWare Projects team is strongly committed to responsible reporting and disclosure of security-related issues. As such, we’ve adopted and follow a set of policies which conform to that ideal and are geared toward allowing us to deliver timely security updates to the official distribution of BeeWare tools, as well as to third-party distributions.

## Reporting security issues

Short version: please report security issues by emailing
[security@beeware.org](mailto:security@beeware.org).
Short version: please report security issues by emailing [security@beeware.org](mailto:security@beeware.org).

Most normal bugs in BeeWare are reported to our public Github issue trackers,
but due to the sensitive nature of security issues, we ask that they not be
publicly reported in this fashion.
Most normal bugs in BeeWare are reported to our public Github issue trackers, but due to the sensitive nature of security issues, we ask that they not be publicly reported in this fashion.

Instead, if you believe you’ve found something in BeeWare which has security
implications, please send a description of the issue via email to
[security@beeware.org](mailto:security@beeware.org). Mail sent to that address
reaches the security team.
Instead, if you believe you’ve found something in BeeWare which has security implications, please send a description of the issue via email to [security@beeware.org](mailto:security@beeware.org). Mail sent to that address reaches the security team.

Once you’ve submitted an issue via email, you should receive an acknowledgment
from a member of the security team within 48 hours, and depending on the action
to be taken, you may receive further followup emails.
Once you’ve submitted an issue via email, you should receive an acknowledgment from a member of the security team within 48 hours, and depending on the action to be taken, you may receive further followup emails.

## Supported versions

At present, the BeeWare team is only committed to providing security updates
to the most recently released versions of our tools.
At present, the BeeWare team is only committed to providing security updates to the most recently released versions of our tools.
13 changes: 4 additions & 9 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Support policy

The BeeWare Project is in the early stages of development. As such, it is still
in rapid development. While we endeavour to minimize backwards compatibility
problems, we make no guarantees at this time.
The BeeWare Project is in the early stages of development. As such, it is still in rapid development. While we endeavour to minimize backwards compatibility problems, we make no guarantees at this time.

As each project in the BeeWare suite of tools and libraries reach a point of
stability, we will increment its version number to 1.0. At that point, we will
introduce a formal backwards compatibility and support policy.
As each project in the BeeWare suite of tools and libraries reach a point of stability, we will increment its version number to 1.0. At that point, we will introduce a formal backwards compatibility and support policy.

## Python Version support.
## Python Version support

We support Python 3.8 and above. Support for pre-release versions of Python is
not guaranteed.
We support all Python versions that have "bugfix" or "security" status [in Python's own version support policy](https://devguide.python.org/versions/). Support for "feature" and "pre-release" versions of Python is not guaranteed.
14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[tool.rumdl]
exclude = [".github/*.md"]
respect-gitignore = true

# MD033: No inline HTML - Used in CoC for header anchors.
disable = ["MD033"]

[tool.rumdl.MD013] # Line length
line_length = 999999
reflow = true
reflow_mode = "normalize"

[tool.rumdl.MD026] # Remove punctuation at the end of headings
punctuation = ",;:"
Loading