Thank you for considering contributing to Amido Stacks. It's people like you that continue to make Stacks the best it can be.
Following these guidelines helps you communicate and participate with the developers maintaining and developing these open source projects. We will cover:
- How to file issues
- How to raise a PR
- How to suggest a new feature
Contributing to Amido Stacks
We love to receive contributions. There are many ways in which you can experience the warm fuzzies of open source contribution, from improving the documentation, writing tutorials or blog posts, submitting issues and feature requests, or writing code which can be incorporated into Amido Stacks.
However, we have a few baselines worth noting:
- Please don't expect your new feature to be implemented unless you or someone else sends a pull request. Submit with a test to get it merged quicker.
- If you have an issue, please tell us how to reproduce it. Bonus points for a failing test case.
- Not everything will be fixed.
- Did we mention we love tests?
Please, don't use the issue tracker if your problem is not strictly Amido Stacks specific. Stack Overflow or other sources are worth considering.
Please read our Code of Conduct. The basis of all is to remember to do good humaning. Everyone is on their own path of challenge and discovery, so please treat others the way you would want to be treated. If you can’t offer praise, offer help instead.
- Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
- Ensure the code meets the requirements in the PR Checklist.
- Create issues for changes and feature requests. Be transparent.
- Be welcoming encourage diverse new contributors from all backgrounds.
- Documentation isn't optional
- Tests aren't optional
How to contribute
Unsure where to being? Start by looking through the following issues labels:
- good-first-issue - should only require a few lines of code, and a test or two.
- documentation - we always need to improve our documentation, it's one of the best ways to contribute.
Sorting the issues by number of comments generally gives a reasonable proxy for the impact the change will have. More comments, more vested interest.
Contributing for the first time to an open source project
No problem! You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
Alternatively, ask us for help.
All work on Amido Stacks is on GitHub. Both Amido maintainers and external contributors send pull requests which go through the same review process. We are using Azure Pipelines as our CI/CD tool of choice. Every PR will invoke a series of steps to build, test, and deploy.
Code changes happen through pull requests
We use Github for hosting and supporting our open source Stack projects. The Amido internal maintainers team will be monitoring Github for pull requests (PRs) and issues.
We actively welcome your pull requests:
- Fork the repo and create your branch from master
- If you've added code that should be tested, add tests.
- Update the documentation.
- Ensure the test suite passes.
- Issue the pull request using the repository PULL_REQUEST_TEMPLATE.md. It's important to link the issue number to ensure that the Issue is closed.
How to report a bug
If you find a security vulnerability, do NOT open an issue. Email Amido instead.
If you aren't sure you've found an security issue, ask yourself the following:
- Can I access something that is not mine?
- Can I disable something for someone else?
If you answered "yes" to either question, please get in contact.
Report bugs using Github issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue. Please follow the issue templates.
In general, please follow the guidelines:
- A quick summary and/or background
- Steps to reproduce
- including sample code
- failing test if possible
- What you expected would happen
- What actually happens
- Impact of the bug
We follow Conventional Commits for all commits and PR's, to ensure we capture the "why" behind every "what".
For versioning, we follow Semantic Version 2.0.0.
Code styling and practices depend on the project. Check the project repo for more information.
If you are interested in talking with Amido on how accelerate your cloud adoption using Amido Stacks then please reach out at Amido.
Special thanks to the open-source inspirations we've loved and used to form our own documentation: contributing-templateinspiration