Skip to content

Latest commit

 

History

History
67 lines (37 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

67 lines (37 loc) · 3.26 KB
Raw

Contributing to AI Muse

Hello and welcome! We're thrilled that you're considering contributing to AI Muse. Your contributions directly enhance app functionality and provide a great learning opportunity. The following guidelines will help you navigate the process.

Code of Conduct

By participating in this project, you're expected to uphold our Code of Conduct.

Getting Started

Set up your local project in your computer

git clone https://github.com/yatendra2001/AI-Muse.git
cd AI-Muse

Create a new branch

git checkout -b feature/<name>

Contributions

Contributions to AI Muse are made through GitHub Pull Requests. Most pull requests start by opening an issue. This lets others in the community know you are working on something and gives them an opportunity to provide feedback and discuss the use case.

  1. Find an issue to work on: Check the 'Issues' tab in GitHub repository and find an issue you're interested in working on.

  2. Fork the repository: Click on 'Fork' at the top right corner of the page and clone the repository to your local machine. This will create a copy of the repository within your personal GitHub account, enabling you to propose changes.

  3. Create a new branch: It's best practice to create a new branch for each new feature or bugfix you'll be working on. Not only is it proper git etiquette, but it also keeps your changes organized and separated from the master branch.

  4. Work on the issue in your forked repository: Now that you're ready to contribute, start modifying the code on your forked repository.

  5. Commit your changes: After making your changes, commit them with a clear and concise commit message.

  6. Submit a pull request: Navigate to your forked repository and click on 'New Pull Request' next to your branch, then 'Create Pull Request'. Ensure you provide a brief description of the proposed changes.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.

Coding Style and Conventions

We use Effective Dart: Style as our coding style guide for Flutter and Dart code. We also use flutter format as our code formatter.

Please make sure that your code follows these standards before submitting a pull request. You can use tools such as flutter_lints package to automate this process.

Testing and Debugging

Please write tests for your changes and make sure that they pass before submitting a pull request. You can run the tests locally with the following command:

flutter test

Contact

If you have any questions or feedback, please feel free to contact us at [email protected]. Remember, the best way to gain contributions is by being respectful and welcoming to new contributors.

We're so excited to see the contributions you'll make!