This repo is run and maintained by the ASPC Software Development Group, but anyone may contribute to this repository! If you attend Pomona College or any of the other Claremont Colleges and would like to join, please feel free to reach out to us at [email protected].
Bugs are tracked as GitHub issues. When you create an issue, please provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. Don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used a mouse or a keyboard.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets on the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
In case you want to suggest for the ASPC Website, please follow this guideline to help maintainers and the community understand your suggestion. Before creating suggestions, please check issue list if there's already a request.
Create an issue and provide the following information where relevant:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Include screenshots and animated GIFs which helps demonstrate the steps or point out the part of the project which the suggestion is related to.
- Explain why this enhancement would be useful.
The high-level development workflow looks something like this:
- Set up your development environment as documented in README.md and the Getting Started Guide.
- Checkout a branch from
master - Make a pull request
Check out a branch from master, our PR base branch. When naming a branch, we try to adhere to the following conventions:
- feature/#NUMBER-[FEATURE-NAME] for new features
- hotfix/#NUMBER-[BUG-NAME] for bug fixes
where #NUMBER corresponds to the number of the related bug or feature request created via GitHub issues