Contribution - Tobionecenobi/SEB GitHub Wiki

Contributing to SEB

First and foremost, thank you for considering contributing to SEB! Community contributions make open-source projects thrive, and we're excited to integrate valuable improvements.

1. Getting Started

  • Fork the Repository: Begin by forking the official SEB repository.

  • Clone Your Fork: Once you have forked the repository, clone it to your local machine to begin development:

    git clone https://github.com/YOUR_USERNAME/SEB.git

2. Development Process

  • Create a Branch: Always create a new branch for each feature or fix. This ensures your changes are organized and easily reviewed:

    git checkout -b feature/your_feature_name

  • Write Code: Develop your feature or fix, keeping a clean commit history with clear and descriptive commit messages.

  • Stay Updated: Regularly pull the latest changes from the upstream SEB repository to stay updated:

    git pull origin master

3. Submitting Your Contribution

  • Push to Your Fork: Once you're ready to submit your changes, push your branch to your fork:

    git push origin feature/your_feature_name

  • Open a Pull Request: Navigate to your fork on GitHub and click the "New pull request" button. Ensure your feature branch is selected, and submit a pull request to the SEB's master branch.

  • Describe Your Changes: In the pull request, provide a clear description of the changes you made, the motivation behind them, and any additional context. If your pull request fixes a specific issue, reference it in the description.

4. Review Process

  • Initial Review: Our maintainers will review your pull request. They might request some changes, improvements, or clarification.

  • Mathematics and Physics Validation: If your contribution involves mathematical or physical concepts, like the addition of a new sub-unit, it is crucial that:

    • Tests: Implement tests to validate the correctness and accuracy of your changes. All new mathematical or physical logic should be accompanied by relevant tests.
    • Documentation: Clearly document and explain the mathematical or physical principles you've used or modified. Ensure equations, algorithms, and methodologies are well-documented, preferably with references or citations if they're derived from existing literature.

  • Acceptance Criteria: Contributions will only be accepted once they fulfill the above criteria, especially for mathematical or physical changes. This rigorous process ensures the accuracy and reliability of SEB for all users.

  • Feedback Loop: Please be patient and receptive to feedback. Our primary goal is to maintain the integrity, accuracy, and reliability of the SEB project.

5. Recognition

Contributors like you make the project grow and evolve. Your contributions are valued and acknowledged. Once your pull request is merged, your name will be added to the list of contributors.

6. Questions?

If you're unsure about something or need clarification, feel free to reach out to our community or the maintainers. We're here to help!