CONTRIBUTING.md

Contribution Guidelines

Thank you for your interest in contributing to Riakmaw! Don't be afraid to contribute your ideas, even if they seem small. All contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. However, we comply with some strict policies to ensure that the project is maintained in a consistent quality and manner.

Please see the Code of Conduct when contributing to this project.

For Contributors

Anyone is welcome to contribute to UserGram. Either it is just a small typo fix or an awesome new feature, we are happy to receive your pull requests.

Pull Requests

• The latest version of the code is always in the staging branch. Please make your pull requests against that branch.
• Pull request need approval from at least one maintainer before it can be merged.
• We encourage you to test your code before submitting a pull request.
• If you are adding a new feature, please provide a clear description in the pull request.

For Maintainers

We use custom scripts together with Conventional Commits to automate releases. This makes the maintainers' process easier and more consistent. Please follows the Conventional Commits specification when committing and merging pull request to the repository.

When merging a pull request make sure:

• Use the "Squash and merge" option.
• Make sure contributors PR's are merged to staging branch.
• Make sure the commit message follows the Conventional Commits guidelines.
  • Use fix for bug fixes.
  • Use feat for new features.
  • Use chore for updating build tasks, package manager configs, etc; no production code change.
  • Use refactor for code changes that neither fixes a bug nor adds a feature.
  • Use docs for documentation changes.
  • Use style for formatting, missing semi colons, etc; no code change.
  • Use test for adding missing tests, refactoring tests; no production code change.