Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

63 lines (51 loc) · 2.84 KB
Raw

Contributing to eventify

Welcome to eventify! We're thrilled that you're interested in contributing. Before you get started, please take a moment to review the following guidelines.

Code of Conduct

This project adheres to the Rust Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to project maintainers.

Getting Started

  • Fork the repository on GitHub.
  • Clone your forked repository: git clone https://github.com//eventify.git
  • Create a new branch for your feature or bug fix: git checkout -b new-feature
  • Make your changes and test them thoroughly.
  • Commit your changes with a descriptive commit message: git commit -am 'Add new feature'
  • Push your changes to your forked repository: git push origin new-feature
  • Open a pull request (PR) against the main repository's main branch.

Pull Requests

  • Ensure your PR addresses only one feature or bug. If you have multiple changes, please submit separate PRs.
  • Include a clear and concise description of your changes in the PR.
  • Use descriptive commit messages and reference any relevant issues or pull requests.
  • All tests must pass before your PR will be considered for merging.
  • If requested, be prepared to make changes based on code reviews. Discuss design decisions early in the process to prevent rework.

Code Style

  • Follow the Rust Style Guide.
  • Write clear and concise code that's easy to understand.
  • Comment your code where necessary to explain complex sections or edge cases.

Testing

  • Write unit tests and integration tests for your code.
  • Ensure your changes don't break existing tests.
  • If your feature is user-facing, consider adding end-to-end tests.

Documentation

  • Document new APIs, libraries, and user-facing changes in the appropriate documentation files.
  • Keep existing documentation up to date.

Reporting Issues

  • Use the GitHub issue tracker to report any issues or bugs.
  • Clearly describe the issue, including steps to reproduce if possible.
  • Include your operating system, Rust version, and any other relevant information.

Collaboration

  • Feel free to join the discussion on open issues, PRs, and design decisions.
  • Be respectful of others' opinions and be open to compromise.

Licensing

  • This project is licensed under the MIT License.
  • Make sure your contributions can be released under this license.

Thank you for your contributions!

If you have any further questions, feel free to open github issues around them. Happy coding!