Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 4.72 KB

contributing.md

File metadata and controls

65 lines (42 loc) · 4.72 KB
Raw

Contributing to ZUnit

✨ Thanks for contributing to ZUnit! ✨

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How can I contribute?

Improve documentation

As a user of ZUnit you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. Anything. Even improvements to this document.

Use the docs label to find suggestions for what we'd love to see more documentation on.

Improve issues

Some issues are created with missing information, not reproducible, or plain invalid. Help make them easier to resolve. Handling issues takes a lot of time that we could rather spend on fixing bugs and adding features.

Give feedback on issues

We're always looking for more opinions on discussions in the issue tracker. It's a good opportunity to influence the future direction of ZUnit.

The question label is a good place to find ongoing discussions.

Write code

You can use issue labels to discover issues you could help out with:

The help wanted and good for beginner labels are especially useful.

You may find an issue is assigned, or has the assigned label. Please double-check before starting on this issue because somebody else is likely already working on it.

We'd like to fix priority issues first. We'd love to see progress on low-priority issues too. future issues are those that we'd like to get to, but not anytime soon. Please check before working on these since we may not yet want to take on the burden of supporting those features.

Hang out in our chat

We have a chat. Jump in there and lurk, talk to us, and help others.

Submitting an issue

  • The issue tracker is for issues. Use our chat for support.
  • Search the issue tracker before opening an issue.
  • Ensure you're using the latest version of ZUnit.
  • Use a clear and descriptive title.
  • Include as much information as possible: Steps to reproduce the issue, error message, ZSH version, operating system, etc.
  • The more time you put into an issue, the more we will.
  • The best issue report is a failing test proving it.

Submitting a pull request

  • Most pull requests should target the next branch, so they can be included in the next release.
  • Urgent bug fixes may be targeted to the master branch, and a new patch release will be created immediately after they are merged. If in doubt, ask.
  • Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work.
  • For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a pull request as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a [WIP] prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need to make.
  • New features should be accompanied with tests and documentation.
  • Don't include unrelated changes.
  • Make the pull request from a topic branch, not master.
  • Use a clear and descriptive title for the pull request and commits.
  • Write a convincing description of why we should land your pull request. It's your job to convince us. Answer "why" it's needed and provide use-cases.
  • You might be asked to do changes to your pull request. There's never a need to open another pull request. Just update the existing one.