-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Development.MD file. #356
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Development | ||
[ For internal contributors only ] | ||
|
||
## Getting Started | ||
|
||
To set up the repo locally, choose one of the following methods: | ||
|
||
### Method 1 (For FastCGI or Srcache) | ||
|
||
1. Create a WordPress website. | ||
2. Clone the [nginx](https://github.com/nginx/nginx) source code in a separate directory. | ||
3. Set up nginx using either FastCGI cache or Srcache module. | ||
4. Manually compile the binary for Nginx. | ||
5. Add a configuration block to redirect incoming requests to the WordPress website. | ||
6. Clone this repository inside the `wp-content/plugins` directory. | ||
|
||
### Method 2 (For Redis Cache) | ||
|
||
1. Install EasyEngine by following the [instructions](https://easyengine.io/docs/install/). | ||
2. Create a site with caching enabled using the command: `ee site create <site_name> --cache` | ||
|
||
3. Clone this repository inside the `wp-content/plugins` directory of the newly created site. | ||
|
||
## Testing | ||
|
||
To verify if a page is cached: | ||
|
||
1. Enable the timestamp option in Nginx Helper from the WordPress Admin Page: | ||
- This adds a comment with cache time and query count. | ||
- Cached pages should show only 1 query. | ||
|
||
2. Manually check the Redis database: | ||
- Search for keys beginning with the prefix specified in your Redis config, followed by a URL. | ||
|
||
## Contributing | ||
|
||
### Raising a Pull Request (PR) | ||
|
||
1. Create a new branch from `master` for your changes. | ||
2. Make your changes and commit them to your branch. | ||
3. Raise a PR targeting the `develop` branch. | ||
4. Assign the PR to a reviewer. | ||
5. Address any feedback and make necessary changes. | ||
6. Once approved, merge the PR into the `develop` branch. | ||
|
||
### Merging to Master | ||
|
||
1. After thorough testing on the `develop` branch, create a new PR. | ||
2. Set the source branch as the original feature branch that was merged into `develop`. | ||
3. Set the target branch as `master`. | ||
4. Assign reviewers and await final approval. | ||
5. Once approved, merge the PR into the `master` branch. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add a messaging that below is for internal contributors only, as the workflow might be different for people outside of rtcamp