Contributing to Alis

Thank you for your interest in contributing to Alis! Your contributions help make this project better for everyone. Whether you're fixing bugs, adding new features, improving documentation, or helping out in any other way, we're excited to have you on board.

Table of Contents

1. Code of Conduct
2. How to Contribute
   • Reporting Bugs
   • Suggesting Features
   • Submitting Changes
3. Development Process
   • Setting Up the Environment
   • Building the Project
   • Running Tests
4. Style Guides
   • Coding Standards
   • Commit Messages
5. Acknowledgments

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expectations we have for all contributors.

How to Contribute

Reporting Bugs

If you find a bug in the project, please open an issue on our GitHub Issues page. When reporting a bug, include:

• A clear and descriptive title.
• Steps to reproduce the issue.
• Expected and actual results.
• Any relevant screenshots, logs, or other information.

Suggesting Features

We welcome feature requests! To suggest a new feature, please open an issue on our GitHub Issues page. Provide a detailed explanation of the feature, its potential benefits, and any examples or mockups that might help illustrate your idea.

Submitting Changes

1. Fork the repository.
2. Create a new branch from main (e.g., feature/awesome-feature).
3. Make your changes in the new branch.
4. Ensure your code follows our Coding Standards and includes tests if applicable.
5. Commit your changes with a descriptive commit message.
6. Push your changes to your fork.
7. Open a pull request to the main branch of the original repository.

Please ensure that your pull request:

• Describes the change you are making.
• References any related issues.
• Includes relevant tests and documentation updates.

Development Process

Setting Up the Environment

To set up your development environment, follow these steps:

1. Clone the repository: git clone https://github.com/pabllopf/Alis.git
2. Navigate to the project directory: cd alis
3. Install dependencies: dotnet restore

Building the Project

Instructions for building the project will vary depending on the technology stack. Ensure you have the necessary tools installed, such as Node.js, Python, etc.

dotnet build alis.sln

Running Tests

Run the project’s tests to ensure your changes don’t break anything:

dotnet test alis.sln

Style Guides

Coding Standards

Adhere to the following coding standards to maintain code quality and readability:

• Follow the language-specific style guides (e.g., PEP 8 for Python, ESLint for JavaScript).
• Write clear, concise, and well-documented code.
• Include comments where necessary to explain complex logic.

Commit Messages

Write meaningful commit messages to make the history easier to understand:

• Use the present tense ("Add feature" not "Added feature").
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
• Include a brief summary of the changes made.
• Reference issues and pull requests when applicable (e.g., Fixes #123).

Acknowledgments

We appreciate your contributions! If your pull request is merged, you will be listed as a contributor in the project's Contributors section.

Thank you for helping make Alis better for everyone!

---