Contributing to datastructpy

Contributing to datastructpy#

We welcome input, feedback, bug reports, and contributions via the datastructpy GitHub Repository. Your participation helps improve this project and ensures its continued success.

All contributions, suggestions, and feedback are accepted under the Project’s license. By contributing, you represent that you own or have the authority to submit the contribution under the Project’s license. All feedback, suggestions, or contributions are not confidential. The project abides by the UBC-MDS Code of Conduct.

How to Contribute Code to datastructpy#

Setting Up Your Environment#

To contribute, you must first be invited by the administrators of the UBC-MDS GitHub organization. Once you have access:

  1. Clone the Repository
    Fork the datastructpy repository on GitHub, then clone your fork to your local machine. For more details on forking, see the GitHub Documentation.

git clone https://github.com/YOUR-USERNAME/datastructpy.git

  1. Sync Your Fork To keep your fork up-to-date with changes in the main repository, use the fetch upstream button on GitHub.

Creating a Branch#

Before making changes, create a new branch for your work:

git switch -c <your-branch-name>

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

Creating and Submitting a Pull Request (PR)#

When you’re ready to submit your changes:

  1. Commit Your Changes Add and commit your changes to the new branch:

git add <modified-files>
git commit -m "Descriptive message about your changes"
git push origin <your-branch-name>

  1. Submit a Pull Request Go to the GitHub repository page and create a pull request from your branch to the main repository. Follow these steps:

  • Provide a clear description of the changes you made and their purpose.

  • Tag an administrator or maintainer as a reviewer to ensure your PR is reviewed promptly.

  1. Communicate in the Pull Request Use the PR discussion thread to communicate with reviewers and collaborators. Respond to feedback and push updates to your branch as needed.

Getting Your Pull Request Merged#

After submitting your Pull Request, reviewers may provide feedback or request changes. Make the necessary updates in your branch and push the changes to automatically update the PR. Once your PR is approved, it can be merged into the main branch.

Additional Notes#

  • Follow existing code style and conventions in the project.

  • Update relevant documentation (if applicable) as part of your PR.

  • Ensure new features are thoroughly tested and maintain existing functionality.

  • Keep communication polite and constructive in all project-related discussions.

Thank you for contributing to datastructpy! Your efforts help make this project better for everyone :)