Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

79 lines (56 loc) · 2.95 KB
Raw

Feedback and Contribution

We welcome any input, feedback, bug reports, and contributions.

All contributions, suggestions, and feedback you submitted are accepted under the Project's license. You represent that if you do not own copyright in the code that you have the authority to submit it under the Project's license. All feedback, suggestions, or contributions are not confidential. The Project abides by the code of conduct.

How To Contribute Code

Setting Up Your Environment

Fork the repository on GitHub and then clone the fork to you local machine. For more details on forking see the GitHub Documentation.

git clone git@github.com:UBC-MDS/wine-quality-regressor-group-2.git

To keep your fork up to date with changes in this repo, you can use the fetch upstream button on GitHub.

Now you can install the conda environment.

conda env create --file environment.yml
conda activate 522

Creating a Branch

Once your local environment is up-to-date, you can create a new git branch which will contain your contribution (always create a new branch instead of making changes to the main branch):

git switch -c <your-branch-name>

With this branch checked-out, make the desired changes to the package.

A large part of Altair's code base is automatically generated. After you have made your manual changes, make sure to run the following to see if there are any changes to the automatically generated files:

hatch run generate-schema-wrapper

For information on how to update the Vega-Lite version that Altair uses, please read the maintainers' notes.

Creating a Pull Request

When you are happy with your changes, you can commit them to your branch by running

git add <modified-file>
git commit -m "Some descriptive message about your change"
git push origin <your-branch-name>

You will then need to submit a pull request (PR) on GitHub asking to merge your example branch into the main Altair repository. For details on creating a PR see GitHub documentation Creating a pull request. You can add more details about your example in the PR such as motivation for the example or why you thought it would be a good addition. You will get feed back in the PR discussion if anything needs to be changed. To make changes continue to push commits made in your local example branch to origin and they will be automatically shown in the PR.

Hopefully your PR will be answered in a timely manner and your contribution will help others in the future.

Part of MVG-0.1-beta. Made with love by GitHub. Licensed under the CC-BY 4.0 License.