Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 1.96 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to UserGram! 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 yoor pull requests.

Pull Requests

  • The latest version of the code is always in the main branch. Please make your pull requests against that branch.
  • Pull request need approval from at least one maintainer before it can be merged.
  • We use ESLint/Prettier for linting and formatting, so please run yarn lint before commiting to make review and merge easier.
  • 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 Conventional Commits for commit messages. Please follow the guidelines when committing to the repository. This makes the maintainance process easier.

Merge Requests

  • Use the "Squash and merge" option when merging pull requests.
  • Make sure contributors PR's are merged to main
  • Make sure the commit message follows the Conventional Commits guidelines.
    • Use fix for bug fixes.
    • Use feat for new features.
    • 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.