Skip to content
This repository has been archived by the owner on May 10, 2023. It is now read-only.

Add a contributing.md #13

Open
johanhelsing opened this issue May 7, 2021 · 1 comment
Open

Add a contributing.md #13

johanhelsing opened this issue May 7, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@johanhelsing
Copy link
Collaborator

@NavidK0 Just wondering how you prefer things to be done?

Things like:

  • Is breaking changes ok (bumping major version of course)? Or do you prefer to avoid this as much as possible?
  • Now that I get write access, do you still prefer changes to go through PRs?
  • Other things?

Might make sense to put this in a contributing.md.

@NavidK0
Copy link
Owner

NavidK0 commented May 7, 2021

For now:

  • Is breaking changes ok (bumping major version of course)? Or do you prefer to avoid this as much as possible?
    We should follow semantic versioning. So if we make a major breaking change (that isn't just removing deprecated APIs), we should increment the major version.
    Introducing breaking changes is fine as long as they are necessary for the health of the project/increase the usability of the project.

  • Now that I get write access, do you still prefer changes to go through PRs?
    Not for anything you don't need us to look over or are certain about. If it's a quality of life change that isn't a huge feature or major change, no need to make a PR when you have write access. (Bug fixes shouldn't need PRs either.)

  • Other things?
    We should have a development branch (or features branches if preferred), and avoid pushing to the main branch until the feature(s) in development is/are stable.
    Other than that, nothing comes to mind.

I'll be sure to write up a proper CONTRIBUTING.md when I get a chance. Thanks for the help!

@NavidK0 NavidK0 added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jun 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants