Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Adding empty CONTRIBUTING.md to start #26 #211

Closed
wants to merge 1 commit into from

Conversation

Leopere
Copy link
Collaborator

@Leopere Leopere commented Nov 15, 2019

Looking to get started on issue #26 we're going to need

Looking to get started on issue #26 we're going to need
@Leopere Leopere added feature Pull requests that add a new feature help wanted Extra attention is needed question investigate Investigation needed labels Nov 15, 2019
@Leopere Leopere mentioned this pull request Nov 15, 2019
@StashAppDev StashAppDev changed the base branch from master to develop November 16, 2019 15:45
@WithoutPants
Copy link
Collaborator

Radarr's contribute guide has some nice bits in it. I've made some modifications to it below:

Contributing Code

  • If you're adding a new, already requested feature, please comment on Github Issues so work is not duplicated (If you want to add something not already on there, please talk to us first)
  • Rebase from the develop branch, don't merge
  • Make meaningful commits, or squash them
  • Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements
  • Reach out to us on the forums or on IRC Discord if you have any questions
  • Add tests (unit/integration)
  • Commit with *nix line endings for consistency (We checkout Windows and commit *nix)
  • One feature/bug fix per pull request to keep things clean and easy to understand
  • Follow existing code formatting conventions: tabs in go files, 2 spaces for tsx files

Pull Requesting

  • Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it
  • You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
  • We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it
  • Each PR should come from its own feature branch not develop in your fork, it should have a meaningful branch name (what is being added/fixed)
    • new-feature (Good)
    • fix-bug (Good)
    • patch (Bad)
    • develop (Bad)

We can probably add something about running go fmt on changed files.

This file should also define and document the workflow we use (whenever we settle on something).

@Leopere
Copy link
Collaborator Author

Leopere commented Nov 19, 2019

I agree with most of it but not really sure if I care if it's on it's own feature branch. I don't really want to get that fickle we already have referential commentary on the github PRs.

@WithoutPants
Copy link
Collaborator

I think it's probably more of a best practise kind of thing. It's not grounds for rejecting a PR, but for someone new to the project, it would be good advice to give.

@Leopere
Copy link
Collaborator Author

Leopere commented Nov 19, 2019

Good idea, we should have an opening clause mentioning that its just guidelines that should be adhered to as best as possible.

@Leopere
Copy link
Collaborator Author

Leopere commented Jan 22, 2020

Gonna close this until we can revisit it.

@Leopere Leopere closed this Jan 22, 2020
@WithoutPants WithoutPants deleted the Leopere-patch-1 branch April 25, 2022 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Pull requests that add a new feature help wanted Extra attention is needed investigate Investigation needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants