Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 2.76 KB

Contributing to effdsl

Thank you for considering contributing to effdsl! Contributions are welcome in the form of bug reports 🐛, feature requests 🌟, and code improvements. Here’s a guide on how to get started:

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please follow these steps:

  1. Check Existing Issues: Before creating a new issue, search the issue tracker to see if the problem or feature request has already been reported.
  2. Create a New Issue: If you don’t find an existing issue, create a new issue with a clear and descriptive title. Provide as much detail as possible, including steps to reproduce the bug or the desired feature.

Submitting Pull Requests

We encourage you to submit pull requests (PRs) to improve the project. Here’s how to do it:

  1. Fork the Repository: Fork the effdsl repository to your own GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/your-username/effdsl.git
  3. Create a Branch: Create a new branch for your changes. 
    git checkout -b your-branch-name
  4. Make Your Changes:: Implement your changes or fixes.
  5. Write Tests: If applicable, write tests to cover your changes.
  6. Commit Your Changes: Commit your changes with a descriptive commit message. 
    git add .
git commit -m "Describe your changes"
  7. Push Your Branch: Push your changes to your forked repository. 
    git push origin your-branch-name
  8. Create a Pull Request: Go to the effdsl repository and create a pull request (PR) from your branch. Provide a clear description of your changes and why they should be merged.

Code of Conduct

A welcoming environment for all contributors is important. Please follow our Code of Conduct when participating in discussions or making contributions.

Coding Standards

  • Write Clear Code: Follow Go coding conventions and write clear, readable code.
  • Document Your Code: Ensure your code is well-documented, especially if it introduces new functionality.
  • Write Tests: If your changes introduce new features or modify existing behavior, include tests to ensure the quality and functionality of the code.

Additional Resources

Thank you again for contributing to effdsl! Your contributions help improve and grow the project. If you have any questions, feel free to ask in the issue tracker or reach out.