Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 1.84 KB

Contributing

Getting Started

  1. Fork this repository to your GitHub account.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/byronalley/criticos.git

  3. See README.md for installation instructions

  4. Create a new branch for your contribution:

    git checkout -b feature/your-feature

Making Contributions

We encourage contributions that align with the goals of our project. Here's how you can help:

  • [Feature] - Implement a new feature.
  • [Bug Fix] - Help us squash those bugs.
  • [Documentation] - Improve our project documentation.
  • [Refactoring] - Make the codebase more efficient and maintainable.

Code Guidelines

  • Elixir code should be formatted with mix format and pass mix credo as well.
  • TODO: add React/JavaScript code formatter config

Testing

  • Ensure your code is thoroughly tested.
  • Run existing tests to make sure you haven't broken any functionality.

Submitting Pull Requests

  1. Push your changes to your forked repository:

    git push origin feature/your-feature

  2. Create a pull request from your forked repository to this project's main branch.

  3. Provide a clear and concise title and description for your pull request, explaining the changes you've made.

  4. The maintainer will review your pull request and provide feedback or merge it.

Code of Conduct

Please be respectful and considerate of the maintainers and other contributors. Communications and contributions should be focused on the code and project, and no form of harassment or spam is acceptable.

License

By contributing to this project, you agree that your contributions will be licensed under the project's License.

Happy Hacking!

Thank you for considering contributing to this project. Your support is greatly appreciated. Happy hacking!