Contributing
Contributing guidelines
We 💙 Pull Requests for fixing issues or adding features. Thanks for your contribution!
For small changes, especially documentation, you can simply use the "Edit" button to update the Markdown file, and start the pull request process. Use the preview tab in GitHub to make sure that it is properly formatted before committing. Please use conventional commits and follow the semantic PR format as documented here . A pull request will cause integration tests to run automatically, so please review the results of the pipeline and correct any mistakes that are reported.
If you plan to contribute often or have a larger change to make, it is best to setup an environment for contribution, which is what the rest of these guidelines describe. The atsign-foundation GitHub organization's conventions and configurations are documented here.
Development Environment Setup
GitHub Repository Clone
To prepare your dedicated GitHub repository:
Fork in GitHub https://github.com/atsign-foundation/at_protocol
Clone your forked repository (e.g.,
git clone git@github.com:yourname/at_protocol
)Set your remotes as follows:
Running
git remote -v
should give something similar to:The use of
upstream --push DISABLED
is to prevent those withwrite
access to the main repository from accidentally pushing changes directly.
Development Process
Fetch latest changes from main repository:
Reset your fork's
trunk
branch to exactly match upstreamtrunk
:IMPORTANT: Do this only once, when you start working on new feature as the commands above will completely overwrite any local changes in
trunk
content.Edit, edit, edit, and commit your changes to Git:
How to run tests:
Open a new Pull Request to the main repository using your
trunk
branch
Last updated