Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 2.81 KB
Raw

Contributing

We welcome contributions to Eryon! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated. That being said, we implore all of our contributors to adhere to a standard of quality and professionalism. Please follow the guidelines below to ensure a smooth contribution process.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We are committed to providing a welcoming and inclusive environment for all contributors.

How to Contribute

Note: Every contribution should have a corresponding feature request or, for larger changes, a dedicated proposal detailing the intended changes and their rationale. This helps maintain clarity and ensures that all contributions align with the project's goals.

  1. Fork the Repository: Start by forking the Eryon repository to your own GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine.
  3. Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name for your branch.
  4. Make Changes: Implement your changes in the new branch. Ensure your code adheres to the project's coding standards.
  5. Test Your Changes: Thoroughly test your changes to ensure they work as expected
  6. Commit Your Changes: Commit your changes with clear and concise commit messages.
  7. Push to Your Fork: Push your changes to your forked repository on Git
  8. Open a Pull Request: Navigate to the original Eryon repository and open a pull request from your forked repository. Provide a detailed description of your changes and the problem they solve.
  9. Address Feedback: Be responsive to any feedback or requests for changes from the project maintainers.

Coding Standards

  • Follow the existing coding style and conventions used in the project.
  • Write clear, concise, and well-documented code.
  • Ensure your code is efficient and avoids unnecessary complexity.
  • Include unit tests for new features or bug fixes.
  • Ensure all tests pass before submitting your pull request.
  • Use meaningful variable and function names.
  • Avoid large, monolithic commits. Break your changes into smaller, manageable commits.
  • Keep your pull requests focused on a single issue or feature.
  • Avoid including unrelated changes in your pull request.
  • Ensure your pull request does not introduce any new warnings or errors.
  • Use descriptive titles and detailed descriptions for your pull requests.
  • Be respectful and professional in all communications related to your contribution.

Reporting Issues

If you encounter any bugs or issues while using Eryon, please report them by opening an issue on the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior.