Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 2.51 KB
Raw

Contribution Guide

Your contributions to our ESL Erlang/Elixir package management project are valuable in improving the platform and supporting the community. This guide outlines the process for contributing and provides guidelines to ensure smooth collaboration:

Before You Begin

  • Familiarise yourself with the project and its goals by exploring the Readme.md and codebase.
  • Ensure you have a GitHub account.

Contributing Code

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine. 
    git clone https://github.com/your-username/repository.git
  3. Create a new branch for your contribution.
git checkout -b branch-name.

  1. Make your code changes, following the project's coding conventions and style guidelines.

  2. Test your changes thoroughly to ensure they work as intended.

  3. Commit your changes with clear and descriptive commit messages.

git commit -m "Brief description of your changes"
  1. Push the changes to your forked repository.
git push origin branch-name
  1. Open a pull request (PR) on the original repository.
  • Provide a clear and concise description of your changes in the PR.
  • Reference any related issues or discussions if applicable.

Contributing Bug Reports or Feature Requests

Go to the GitHub repository's "Issues" tab.

Search for existing issues to check if your bug or feature request has already been reported/discussed.

If not found, click on "New Issue" to create a new one.

For bug reports, provide a detailed description of the issue, steps to reproduce it, and any relevant information about your environment.

For feature requests, explain the desired functionality and why it would be beneficial. Submit the issue and await feedback or further discussion from the project maintainers.

Community Guidelines

  • Be respectful and considerate in all interactions within the community.
  • Provide constructive feedback and suggestions.
  • Help fellow contributors by answering questions and providing assistance when possible.
  • Follow the code of conduct of the project and treat all participants with respect and kindness.

We appreciate your contributions and strive to review and respond to them in a timely manner. Your involvement helps us build a better Erlang/Elixir package management platform for the community.

If you have any further questions or need assistance, feel free to reach out to us through the GitHub repository's issue tracker or Discord.

Thank you for being a part of our project!