Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

65 lines (49 loc) · 2.86 KB
Raw

Contributing to XestiMonitors

XestiMonitors is an extensible monitoring framework written in Swift. Pull requests are welcome.

Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you understand what actions will and will not be tolerated.

Get Involved

There are many ways to contribute to XestiMonitors. Here are a few ideas:

  • Look through the open issues. Provide workarounds, ask for clarification, or suggest labels.
  • Simply start using XestiMonitors. Go through the reference documentation. Does everything work as expected? If not, we’re always looking for improvements. Let us know by opening an issue.
  • Take a look at the features requested by others in the community and consider opening a pull request if you see something you want to work on.

Opening a Pull Request

So you’ve decided to contribute code back upstream by opening a pull request. You’ve invested a good chunk of time and we appreciate it. We’ll do our best to work with you and get the PR looked at.

To help speed up the process, please make sure all the following are done when submitting a pull request:

  1. Fork the repository and create your branch from master.
  2. Add the copyright notice to the top of any new files you’ve added. (Try to match the format in other files. For example, the created date is in ISO format. The copyright year should be the current year.)
  3. Make sure to write unit tests for your changes!
  4. Ensure that your changes are well documented as we strive to maintain 100% documentation coverage of all public interfaces.
  5. Where possible, add a demo of the new feature to our example apps.
  6. Reference the issue number in the pull request description.

Reporting a New Issue

When creating a new issue, always make sure to fill out the issue template. This step is very important!

Not doing so may result in your issue getting closed. Don’t take it personally if this happens. Feel free to open a new issue once you’ve gathered all the information required by the template.

  • One issue, one bug: Please report a single bug per issue.
  • Provide reproduction steps: List all steps neccessary to reproduce the issue.
  • Mention the platform you are using (iOS, macOS, tvOS, watchOS).
  • Try out the latest version of XestiMonitors. The bug may be fixed already.

License

By contributing to XestiMonitors, you agree that your contributions will be licensed under its MIT license.