Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

66 lines (39 loc) · 2.87 KB
Raw

Contributing

Thank you for your interest in contributing to Echelon! We appreciate your time and effort in making this project better. Here's how you can get started:

Code of Conduct

Please review and adhere to our Code of Conduct to ensure a respectful and inclusive community for everyone.

Ways to Contribute

There are several ways you can contribute to the Echelon project:

  1. Reporting Issues: If you encounter a bug, have a feature request, or notice any other issue, please submit a detailed issue on our GitHub repository.

  2. Pull Requests: You can contribute by submitting pull requests to address open issues or improve the project. We welcome improvements, bug fixes, documentation enhancements, and more.

  3. Documentation: Enhance our documentation by fixing typos, adding examples, or improving explanations. Documentation improvements are greatly valued!

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top-right corner of this repository to create your own copy.

  2. Clone the Repository: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/mlevit/echelon.git

  3. Create a New Branch: Before making changes, create a new branch for your contribution. Use a descriptive name for your branch that reflects the changes you're making.

    git checkout -b feature/new-feature

  4. Make Changes: Make your desired changes to the codebase or documentation.

  5. Commit and Push: After making changes, commit them and push to your forked repository.

    git commit -m "Add new feature"
git push origin feature/new-feature

  6. Create a Pull Request: Go to the original repository on GitHub and click the "New Pull Request" button. Provide a clear title and description for your pull request, explaining the changes you made.

  7. Review and Collaboration: Your pull request will be reviewed by project maintainers. Feedback and discussions might occur, so be prepared to make necessary changes.

  8. Merge and Close: Once your pull request is approved and meets all requirements, it will be merged into the main repository. Congratulations on your contribution!

Code Guidelines

Please follow these guidelines when contributing code:

  • Use descriptive commit messages.
  • Write clear and concise code with meaningful variable/function names.
  • Adhere to the coding style and conventions used in the project.
  • Write tests to cover your code changes whenever applicable.
  • Keep your pull request focused on a single task/issue.

Thank You

Your contributions are essential to the success of the Echelon project. We appreciate your dedication and look forward to working together to improve the project. If you have any questions, feel free to ask on the Discussions page.

Happy coding!

— The Echelon Team