Skip to content
This repository was archived by the owner on Nov 23, 2021. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 2.7 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This document is enforced across all of the Pins team's open-source projects in GitLab and GitHub unless otherwise specified. This Contributing Documentation Guide is for non-law experts only. If you're an law expert, please take an look at docs/about/CONTRIBUTING/for-law-experts

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off/approval of two other developers, and an project reviewer/maintainer or an staff from the Pins team, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
  5. Everytime you make an commit and pushed into this repository, the apporval counts will reset. Make sure your work is ready for approval and final to avoid any issues.

Issue Process

  1. Ensure the issue you create doesn't have any duplicates. Any duplicates will be closed and merged to the original issue.
  2. Join the discussion only if you know what topic is being talked and avoid any sort of off-topic mess.
  3. Avoid commenting any Not Safe for Work content or even try to swear bad language. Instead, please censor using emojis (when in text) and edit the screenshot/picture to censor parts that seems to be NSFW.

Commiting Process

  1. The main branch, master are usually can be only editable by staffs. We recommed to contribute on dev or staging branch or any branch where the community or the staffs are working.
  2. Whne requesting push access to an branch, please contact the staff for any inquiries and follow our instructions.
  3. Resolve any merge conflicts locally with caution. Please also notify other contributors before resolving any conflicts.

Localization Process

See the provided dcumentation instead