Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 3.4 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to Swaplace! The project is an open-source build by the community. We welcome any type of contribution, suggestion or improvement, no matter how small.

Contents

How to Contribute

There are many ways to contribute, but here are a few steps to start:

  1. Fork the repository in GitHub.

  2. Check if you have any issue, suggestion or improvement to work on.

  3. Send a message in the issue like I'm interested in this issue or ask for more information such as Hey, can you provide more information about this ... ? The mantainers will then assign or provide more context about your issue. After that, you are asigned to the issue.

  4. If a task is already assigned but you believe you can expedite the process, feel free to comment, requesting to assist or speed up the task. Additionally, you may open a pull request directly because we prioritize both code efficiency and delivery speed. Thus, we encourage multiple individuals to review the same issues and debate together to enhance the code's security.

Congratulations ! You can now start working on the issue, and everyone is aware that you are assigned.

Opening An Issue

Before opening an issue, please check if there is any issue already open. If there is, feel free to comment or suggest more details. We are always open to feedback and receptive to suggestions!

Writing Commit Messages

We are using Conventional Commits

Some examples below:

  • feat: adds or remove a new feature
  • fix: fixes a bug
  • refactor: rewrite/restructure your code
  • chore: changes to the build process or auxiliary tools and libraries such as documentation generation
  • style: changes do not affect the meaning (white-space, formatting, missing semi-colons, etc)
  • test: add missing tests or correcting existing tests
  • docs: affect documentation only

Submiting Pull Requests

You can resolve an issue and after that submit a pull request fixing an issue and remember to reference that issue. When submitting a PR, put the code below with the number of the issue you are closing Example: closes #1

Code Review

The maintainers will review your PR. If something is missing or a fix needs to be made, the maintainers will let you know in the PR comment.

Coding Style

In Swaplace please use this .prettierrc.yml configuration to make the code standardized.

{
   trailingComma: "all"
   singleQuote: false
   printWidth: 80
   tabWidth: 2
   semi: true
}

Get in Touch

If you need to get in contact with the repository maintainers, please reach out in our Discord.