Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (65 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

99 lines (65 loc) · 3.25 KB

Contributing

Thank you for contributing to the project! The fact that you're even reading this means that you're awesome!

Table of Contents

  1. Contributing
    1. Overview
    2. Development Process
    3. Pull Requests
    4. Issues
      1. Feature
      2. Bug
      3. Docs
      4. DevOps
    5. Pull Requests
    6. Code of Conduct
    7. Coding Style
    8. License

Overview

There are all kinds of contributors and most of them are valuable. Helping with documentation and examples are great way to start contributing to this project. Adding suggestions for features, reporting bugs or even fixing stuff yourself are always appreciated.

Development Process

Contributions can be made through GitHub pull requests. All code changes are reviewed by myself and merged based on the following criteria.

  1. they fix something that is broken
  2. they add something useful
  3. they comply with the coding standards
  4. they are in line with the goal of the library

Pull Requests

We actively welcome your pull requests. If you are planning on doing a larger chunk of work or want to change the API, make sure to file an issue first to get feedback on your idea.

  1. Fork the repo and create your branch from main.
  2. name your branch relative to what you're contributing. These make it really easy to see what you're trying to do.
    1. features start with feature/
    2. bug fixes start with bugfix/
    3. documentation changes start with docs/
    4. devops changes start with devops/
  3. If you've added code that should be tested, add tests. This will likely be most code.
  4. Ensure the test suite passes and your code lints.
  5. Consider squashing your commits (git rebase -i).
  6. In the pull request, link to an issue or provide more context on the intentions of your contributions.

Issues

Before you open an issue, please make sure to check out the open issues to see if your topic is already covered.

Open an issue with the following information

Feature

  1. Title: feature - my cool feature request
  2. Body: Description, Links, Todos

Bug

  1. Title: bug - my cool bug report
  2. Body: Description, System Specs, Links, Todos

Docs

  1. Title: docs - my cool document change
  2. Body: Description, Links, Todos

DevOps

  1. Title: devops - my cool devops task
  2. Body: Description, Links, Todos

Question

  1. Title: question - my cool question
  2. Body: Description, Links

Pull Requests

Feel free to make pull requests. I'll be sure to review them as soon as I can. note Comments on pull requests are not personal attacks on you.

Code of Conduct

(these rules are just temporary)

Don't be an mean. Just be cool. If you aren't, I'm just gonna ban you.

Coding Style

  • Match the style you see used in the rest of the project. This includes formatting, naming things in code, naming things in documentation.
  • use zig fmt on your code changes before submitting.

License

By contributing to stdx, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.