Forest Research is Great Britain’s principal organisation for forestry and tree related research.
Guidelines for repository maintenance
| Principle | Guidance |
|---|---|
| Maintain a clear, concise, organised repository | |
| Use a README file | - Maintain detailed README files that document your project effectively |
| Peer Requests and Code Reviews | − Use pull requests to discuss changes before merging − Encourage peer code review – have some review guidelines - See best practices for pull requests |
| Use Git Large File Storage | - About Git Large File Storage |
Guidelines for version control
| Principle | Guidance |
|---|---|
| Commit practices | − Descriptive commit messages – there are git best practices for these (capital letter to start, imperative tense, no full stop…) − Small and frequent commits as opposed to larger, infrequent ones - Write Better Commits, Build Better Projects |
| Releases and Tags | − Mark stable versions for ease of reference − Simplifies deployment - About Releases |
| Utilise ‘.gitignore’ | - Ignoring files |
Guidelines for community engagement
| Principle | Guidance |
|---|---|
| Licensing | − Clearly define and include licensing information for your projects - Licensing a repository - About CITATION files |
| Contributor Guidelines | − Provide clear guidelines for contributors, including how to report issues, propose changes, and participate in the project - About READMEs |
| Acknowledgment | − Acknowledge and credit contributors for their contributions to foster a positive and inclusive community |
Guidelines for continuous improvement
| Principle | Guidance |
|---|---|
| Feedback and Iteration | − Encourage feedback from contributors and stakeholders to continuously improve processes and documentation |
| Metrics and Analytics | − Track and analyse repository metrics to identify areas for improvement and measure project success |
| Learning and Training | − Invest in training sessions to educate team members on GitHub best practices and new features |
TBC
