Making Contributions

We welcome suggestions and improvements for issues, maintainability/compatibility, and new features! There are two main ways to contribute to LambdaNative: Opening an Issue and Opening a Pull Request.

Issues

You can use the Issues tab to ask questions, request features, and report bugs. Please be as detailed as possible in describing your issue, and include what platform you are developing on and targeting. If applicable, include code snippets. You can add code by putting text between tick marks, as so: ` code goes here `. This will appear as: code goes here. For a longer code block, put the entire block between three ticks at the start (```) and three at the end (```). For more formatting options, the best way to learn is to click Edit on another page or comment. Just be careful not to save edits to another page or comment by mistake!

Pull Requests

If you are able to work on an issue yourself, or have implemented a new feature you'd like to share, please open a pull request. Pull requests are easy to make, help improve the community, and give your code a chance to shine! There are four key steps in making a pull request:

1. Create a new branch. This is preferably done before you start making changes, but can be done after as well. Making a new branch is easy, just run git branch [branchname], using whatever name you like for [branchname] (something related to the changes you're making works well). After that, use git checkout [branchname] to switch to the new branch.

2. Commit your changes. Use git add [file] to add any of the modified files to the commit (git status helps identify modified files) and then git commit -m '[message]' to commit. [message] should be a brief description of the changes made. You will have an opportunity to provide a complete description later.

3. Push the changes. Use git push origin [branchname] to upload your branch to our repo.

4. Open the pull request. Go to Pull requests and click "New pull request". It will ask you to select a branch and commit, and should suggest the branch you've been recently working on. It will ask for a comment, and here you should provide a full description of your changes. This starts a discussion with the core group about whether and how the changes should be made. This provides other contributors a chance to collaborate on the request. In some cases, the request may be deemed unsafe or unnecessary and abandoned. When the changes are complete, they can be submitted for review by an admin - the change will then either be merged into the master branch, or sent back to the editing phase.