Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Contributions from Internal Contributors

As a core team member, you play a vital role in the development and maintenance of the project. Here are some guidelines specifically for you:

Division of Labor:
- Each team member is assigned specific tasks. Tasks are assigned to team members based on the estimated workload of each task to ensure a fair and balanced distribution of responsibilities.
- Tasks include the development of main functions, writing tests, updating documentation, and maintenance work.
Rotating Project Management:
- We use the GitHub Project Board for project management. This includes task assignments, tracking progress, and managing deadlines.
- Each team member takes a turn at being the project manager for a week.
- The project manager is responsible for overseeing the week's progress, ensuring that deadlines are met, and assisting team members as needed.
Collaboration and Peer Review:
- Regular code reviews and team meetings are held to ensure quality and consistency.
- Team members are encouraged to collaborate and support each other, especially in areas requiring specific expertise.
Best Practices: Adhere to our established coding standards and best practices. Ensure that your code is well-documented and tested.

We warmly welcome contributions from outside the core team. Here's how you can contribute:

Fork the Repository: Start by forking the repository to your own GitHub account.
Clone Your Fork: Clone the forked repository to your local machine to start working on your changes.
```
$ git clone https://github.com/your-username/dscigametrics.git
```
Create a Branch: Navigate to the cloned directory and create a new branch for your contribution.
```
$ cd dscigametrics
$ git checkout -b your-new-branch-name
```
Make Your Changes: Implement your bug fix, feature, or documentation update and commit your changes using clear and descriptive commit messages.
Push Your Changes: Push your changes to your fork.
```
$ git push origin your-new-branch-name
```
Open a Pull Request: Navigate to the original dsci-GA-metrics repository and open a pull request from your forked repository and branch. Please provide a detailed description of your changes and the purpose of your contribution.
Respond to Feedback: Be ready to respond to feedback on your pull request. The core team may request changes or provide suggestions to improve the contribution.

Before you submit a pull request, check that it meets these guidelines:

The pull request should include additional tests if appropriate.
If the pull request adds functionality, the docs should be updated.
The pull request should work for all currently supported operating systems and versions of Python.

Please note that the GA-metrics project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.