Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 2.95 KB
Raw

Contributing to calver-go

🎉 First off, thanks for taking the time to contribute! 👍

This open source project is developed and maintained by Loadsmart and you 😃.

When contributing to this repository, please first discuss the change you wish to make via github issues or any other method with the owners of this repository before making a change.

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

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive and sustainable environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members 💛

Pull Request Process

  1. Open a Pull request in calver-go repository for your changes and request for the review from other developers, who may be the file owner or anyone should review this piece of code.
  2. Once the Pull request is approved, you may merge the Pull Request once all checks pass and merge is allowed:tea:. Or if you do not have permission to do that, you may request reviewers or repo owners to merge it for you.
  3. You may merge the Pull Request once all checks pass and merge is allowed 🍵. Or if you do not have permission to do that, you may request reviewers or repo owners to merge it for you.
  4. (Optional) If your branch needs a rebase before merge, you can do this process applying a rebase from its parent branch (i.e. master)
$ git checkout master
$ git pull
$ git checkout -
$ git rebase master
$ git push -f

🎉🎉🎉 😉 It is a good idea to run your tests again.

For more details about Pull requests in GitHub, you can find it in the official documentation.

Bug Reporting Process

A bug is a demonstrable problem that is caused by the code in the repository. Please create an issue or open a pull request if you find any issue ☝️. We really appreciate any report. Thank you!

Code Guidelines

Naming convention

"There are only two hard things in Computer Science: cache invalidation and naming things." — Phil Karlton

Meaningful and understandable variables name helps anyone to understand the reason of using it. The name of the function must describe the reason of using the function clearly and briefly.