Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 2.5 KB

Contributing

Welcome to Permify contribution guidelines, happy to see you here 😊

Before dive into a contributing flow and steps for creating good issues and pull requests. We must spesificy that all of the contributions must follow our Code of Conduct. Please read it before you make any contributions.

If you need any help or want to talk about about a spesific topic, you can reach out to me. I'm Ege one of the co-founders of Permify and here is my email: [email protected]

You're always more than welcome to our other communication channels.

Communication Channels

permify | Discord permify | Twitter permify | Linkedin

Issues

The best way to contribute to Permify is opening a issue. If you found any bug on Permify or mistake in our documents, contents you can open an issue about it to let us know. Evaluating problems and fixing them is high priority for us.

When opening a issue

  • If you plan to work on a problem, please check that same problem or topic does not already exist.
  • If you plan to work on a new feature, our advice it discuss it with other community members/maintainers who might give you a idea or support.
  • If you stuck anywhere, ask for help in our discord community.
  • Please relate one bug with one issue, do not use issues as bug lists.

After issue creation, If you are looking to make your contribution follow the steps below.

Contribution Steps

  • Fork this repository.
  • Clone the repository you forked.
  • Create a branch with spesified name. Its better to related with your issue title.
  • Make necessary changes and commit those changes. Make sure to test your changes.
  • Push changes to your branch.
  • Submit your changes for review.

You can create an issue and contribute about anything you want but following above steps will definitely ease your work and other maintainers too.