Files
asciinema/CONTRIBUTING.md

47 lines
1.7 KiB
Markdown
Raw Normal View History

2016-02-14 17:09:02 +01:00
# Contributing to asciinema
2022-02-13 17:04:12 -05:00
First, if you're opening a GitHub issue make sure it goes to the correct
repository:
2016-02-14 17:09:02 +01:00
2022-02-13 17:04:12 -05:00
- [asciinema/asciinema](https://github.com/asciinema/asciinema/issues) - command-line recorder
- [asciinema/asciinema-server](https://github.com/asciinema/asciinema-server/issues) - public website hosting recordings
- [asciinema/asciinema-player](https://github.com/asciinema/asciinema-player/issues) - player
2016-02-14 17:09:02 +01:00
## Reporting bugs
2022-02-13 17:04:12 -05:00
Open an issue in GitHub issue tracker.
2016-02-14 17:09:02 +01:00
Tell us what's the problem and include steps to reproduce it (reliably).
2022-02-13 17:04:12 -05:00
Including your OS/browser/terminal name and version in the report would be
great.
2016-02-14 17:09:02 +01:00
## Submitting patches with bug fixes
If you found a bug and made a patch for it:
2022-02-13 17:04:12 -05:00
1. Make sure all tests pass. If you add new functionality, add new tests.
1. Send us a pull request, including a description of the fix (referencing an
existing issue if there's one).
2016-02-14 17:09:02 +01:00
## Requesting new features
We welcome all ideas.
2022-02-13 17:04:12 -05:00
If you believe most asciinema users would benefit from implementing your idea
then feel free to open a GitHub issue. However, as this is an open-source
project maintained by a small team of volunteers we simply can't implement all
of them due to limited resources. Please keep that in mind.
2016-02-14 17:09:02 +01:00
## Proposing features/changes (pull requests)
2022-02-13 17:04:12 -05:00
If you want to propose code change, either introducing a new feature or
improving an existing one, please first discuss this with asciinema team. You
can simply open a separate issue for a discussion or join #asciinema IRC
channel on Libera.Chat.
2016-02-14 17:09:02 +01:00
## Reporting security issues
2022-02-13 17:04:12 -05:00
If you found a security issue in asciinema please contact us at
2023-08-14 11:05:36 +02:00
admin@asciinema.org. For the benefit of all asciinema users please **do
2022-02-13 17:04:12 -05:00
not** publish details of the vulnerability in a GitHub issue.