Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 2.42 KB

Contributing

MojoAuth JAVA SDK is MIT licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a separate branch from dev branch to base your work.
  • Make commits of logical units.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Make sure to proofread the content before submitting
  • Submit a pull request to the original repository.
  • Please ensure that you raise a PR on dev branch instead of main.

Commit Messages

Please follow the below format while writing commit messages

  title: One line description about your change
  <Blank Line>
  description: An optional description of your changes.

Reporting New Issues

  • Please specify what kind of issue it is.
  • Before you report an issue, please search for related issues. Make sure you are not going to open a duplicate issue.
  • Explain your purpose clearly in tags(see Useful Tags), title, or content.

Group members will confirm the purpose of the issue, replace more accurate tags for it, identify related milestone, and assign developers working on it.

  • Type: What kind of issue, e.g. feature, bug, documentation, performance, support ...

Thanks for your contributions!

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 make 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 Responsibilities

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.****