Contributing

Coming soon

EUGENe is designed to be a community project and there are no shortage of places to start contributing to EUGENe (many outside of just writing code!). All contributions, including bug reports, bug fixes, documentation improvements, enhancement suggestions, and other ideas, are welcome. Everyone within the community is expected to abide by our code of conduct

Please do not hesitate to contact us if you have any questions or suggestions.

Large parts of this document came from the Pandas Contributing Guide.

#Where to start?

#Bug reports and enhancement requests

##Submitting a bug report

#Version control, Git, and GitHub

#Development workflow

##Creating a development environment

##Update the main branch

##Create a new feature branch

##The editing workflow

##Commit and push your changes

##Open a pull request

#Creating a development environment

##Creating a Python Environment

##Install pre-commit hooks

#Contributing to the documentation

##About the xarray documentation

##How to build the xarray documentation

###Building the documentation

###Writing pages

####Referring to other documents and sections

#Contributing to the code base

##Code standards

###Code formatting

###Backwards compatibility

##Testing with continuous integration

##Test-driven development code writing

###Writing tests

###Using pytest

##Running the test suite

##Documenting your code

#Contributing your changes to EUGENe

##Commiting your code

##Pushing your code

##Review your code

##Delete your merged branch

##PR Checklist