Skip to content

Commit

Permalink
[dev] update contributing.md, include link to CAA
Browse files Browse the repository at this point in the history
  • Loading branch information
saulpw committed Jan 29, 2024
1 parent 5ec117d commit e908b48
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ VisiData is designed to be extensible, and most feature requests can be implemen
If this would require changes to the VisiData core, and a reasonable design is approved, then the issue can stay open until the core changes have been made.
Otherwise, in the spirit of Marie Kondo, the issue will be closed without prejudice.

Feature requeste with some amount of working Python code are more likely to get attention.
Feature requests with some amount of working Python code are more likely to get attention.
Design proposals with concrete use cases are very welcome.

## Writing a well constructed bug report
Expand All @@ -50,28 +50,28 @@ If you encounter any bugs or have any problems, please [create an issue on GitHu

A great bug report will include:

- a stacktrace, if there is an unexpected error; the most recent full stack traces can be viewed with `Ctrl+E` (then saved with `Ctrl+S`)
- a [.vd](http://visidata.org/docs/save-restore/) and sample dataset that reproduces the issue
- a .png/.gif (esp. for user interface changes)
- a stacktrace, if there is an unexpected error; the most recent full stack traces can be viewed with `Ctrl+E` (then saved with `Ctrl+S`)
- a [.vd](http://visidata.org/docs/save-restore/) and sample dataset that reproduces the issue
- a .png/.gif (esp. for user interface changes)

Some examples of great bug reports:

- [#350 by @chocolateboy](https://github.com/saulpw/visidata/issues/350)
- [#340 by @Mikee-3000](https://github.com/saulpw/visidata/issues/340)
- [#350 by @chocolateboy](https://github.com/saulpw/visidata/issues/350)
- [#340 by @Mikee-3000](https://github.com/saulpw/visidata/issues/340)


## Submitting Source Code

Check out the [Plugin Authors Guide](https://visidata.org/docs/api) for an overview of the API.
Code in `plugins/` or `visidata/loaders/` is welcome, as long as it is useful to someone and safe for everyone.
Code in `visidata/features/` or `visidata/loaders/` is generally welcome, as long as it is useful to someone and safe for everyone.
Updates or additions to the core code should be proposed via an [Github Issue](https://github.com/saulpw/visidata/issues/new/choose) before submitting a PR.

VisiData has two main branches:

- [stable](https://github.com/saulpw/visidata/tree/stable) has the last known good version of VisiData (what is in pypi/brew/apt).
- [develop](https://github.com/saulpw/visidata/tree/develop) has the most up-to-date version of VisiData (which will eventually be merged to stable).

All pull requests should be submitted against `develop`. Submitters will need to e-sign a Copyright Assignment Agreement (CAA) before a pull request will be accepted.
All pull requests should be submitted against `develop`. Submitters will need to e-sign a [Copyright Assignment Agreement (CAA)](https://visidata.org/caa) before a pull request will be accepted.

# Open Source License and Copyright

Expand Down

0 comments on commit e908b48

Please sign in to comment.