Contributing
There are many to get involved with the SciCat project:
- Documentation - Fixing errors, covering weaker areas, adding examples. Documentation is divided between the homepage, documentation pages, and READMEs in the repositories.
- Github Issues - This should be the first area to focus on for those that want to amend the code. To see how the project is developed, see the Git Workflow page.
- Testing - Most repositories contain unit tests. Integration between components is tested with scicatlive, which is also the easiest way to run and develop SciCat locally.
- Development - For information about the development method we follow, please check Git Flow Workflow.
Communication is done through github issues, a slack channel, and a biweekly developer meeting. Please contact the project leader, Max Novelli, for more information on getting involved.
Issues
Issues are handled within the Github Issue tracker. Please follow the provided template for each repository.
Merge Requests
There should be no pushing directly to the main, master or develop branches.
To implement a fix, fork the repository and create a branch (eg fix/ISSUE-NAME)
complete all work there. When it is complete, open a Pull Request, which will be
reviewed and merged by the core developers.