Skip to content

Contributing

We are looking for contributors to help us develop the language. If you are interested, please make contributions to the eigerproject/eigercs repository.

How to contribute

  1. Fork the repository
    • Navigate to the eigerproject/eigercs
    • Click the Fork button at the top right of the page
  2. Clone the repository
    • Clone your forked repository to your local machine git clone https://github.com/YOUR-USERNAME/eigercs.git
    • Navigate into the cloned directory cd eigercs
  3. Create a new branch
    • Create and switch to a new branch for your changes git checkout -b my-feature-branch
  4. Make Changes
    • Implement your changes or additions to the codebase
    • Ensure your code follows the project's coding standards and guidelines
  5. Commit Changes
    • Add the files you changed git add .
    • Commit your changes with a meaningful commit message git commit -m "Describe your changes here"
  6. Push to the branch
    • Push your changes to your forked repository git push origin my-feature-branch
  7. Create a PR (Pull Request)
    • Go to the eigerproject/eigercs repository
    • Click the "Compare & Pull Request" button next to your recently pushed branch
    • Provide a clear title for your pull request
    • Describe the changes you made and why they are necessary
    • Submit the pull request

Contribution Guidelines

  • Code Style: Ensure your code adheres to the coding standards and conventions used in the project. Run the formatter (Ctrl+K Ctrl+D for Visual Studio) as required.
  • Testing: Write tests for your changes and ensure all existing tests pass. Unit tests are comming soon
  • Documentation: Update the documentation to reflect your changes, if applicable. Ensure that the documentation is clear and concise.
  • Commit Messages: Use meaningful and descriptive commit messages.

Reporting Issues

If you encounter any bugs or issues while using Eigerlang, please report them by opening an issue in the repository. Provide as much detail as possible, including steps to reproduce the issue, your environment, and any relevant error messages.

Getting Help

If you need help with anything related to Eigerlang, feel free to reach out by opening a discussion in the GitHub repository.

Acknowledgements

We greatly appreciate all contributions from the community. Thank you for helping us improve Eigerlang!