Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 2.79 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to the Eternum!

Code of Conduct

We expect all contributors to foster a welcoming and inclusive environment.

Getting Started

  1. Fork the repository: Click the "Fork" button in the top-right corner of the repository to create your own copy.
  2. Clone your fork: Clone your forked repository to your local machine with git clone https://github.com/BibliothecaDAO/eternum.git.
  3. Create a branch: To keep your changes organized, create a new branch with a descriptive name, such as git checkout -b new-feature-name.
  4. Sync your fork: Regularly synchronize your fork with the upstream repository to stay up-to-date with the latest changes.

Reporting Issues

If you encounter a bug or want to suggest a new feature, please create an issue in the Issue Tracker. Be sure to provide the following information:

  • A clear and concise description of the issue or feature
  • Steps to reproduce the bug (if applicable)
  • Any relevant error messages or screenshots
  • Suggestions for resolving the issue or implementing the feature

Submitting Changes

  1. Commit your changes: Make your changes and commit them with a meaningful commit message that describes the changes you've made.
  2. Pull the latest changes: Before submitting your pull request, pull the latest changes from the upstream repository to minimize conflicts.
  3. Push your changes: Push your changes to your forked repository on GitHub.
  4. Create a pull request: Open a new pull request on the original repository. In the description, provide an overview of your changes and any additional context.

Code Style and Quality

Please adhere to the following guidelines when writing code for the Eternum project:

  • Write clean, readable, and well-documented code.
  • Use descriptive variable and function names that reflect their purpose.
  • Organize your code into modular components to improve maintainability.
  • Ensure your code is compatible with the existing codebase and follows the project's coding conventions.
  • Include tests to verify the functionality of your changes.

Review Process

Once you submit a pull request, maintainers will review your changes and provide feedback. Your pull request may be accepted immediately, or it may require further changes. Be patient and open to the feedback, as our goal is to ensure the highest quality code for the Eternum project.

Recognition

Your contributions to the Eternum project are valued and appreciated! All contributors will be recognized and acknowledged in the project documentation.

Thank you for adhering to these guidelines and for your commitment to making the Eternum project a success!